Skip to content
This repository has been archived by the owner on Jun 1, 2020. It is now read-only.

Commit

Permalink
Merge pull request #19 from Rulox/develop
Browse files Browse the repository at this point in the history
Update Readme
  • Loading branch information
Rulox authored Sep 21, 2016
2 parents da0bd70 + 0f977cb commit 52e6c58
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 3 deletions.
25 changes: 23 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,8 +89,14 @@ them in order to do your own app!
* Home
* About

## Folder structure and explanation
WIP
## Creating your own component

To create a new component, just create a new folder in the atoms/molecules/organisms/templates folder with the
name of your component.

Create now the React component in the js file. Also create your .scss file and remember to import it in the _style.scss
of the parent folder (For example, if you're creating a new atom called Checkbox, you should have `atoms/Checkbox/_style.scss`. So in
the main style file for atoms `atoms/_style.scss` just import your new scss file so it can be imported.

## NPM Scripts
This project comes with the following scripts to help you.
Expand All @@ -102,5 +108,20 @@ npm run start
2. Launch a browsersync web server and open default browser.
3. Launch watchers on JS/CSS files.

```bash
npm run build-dev
```
1. Build CSS and JS from sources but does not start browsersync server.

```bash
npm run js-lint
```
1. Launch JS Lint checker.

```bash
npm run sass-lint
```
1. Launch SASS Lint checker.

## Contributions
Feel free to create a pull request or create an issue to add features or fix bugs.
4 changes: 3 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@
"description": "Basic Structure for React app following Atomic Design",
"scripts": {
"start": "gulp",
"js-lint": "gulp jslint"
"build-dev": "gulp js && gulp sass",
"js-lint": "gulp jslint",
"sass-lint": "gulp stylelint"
},
"repository": {
"type": "git",
Expand Down

0 comments on commit 52e6c58

Please sign in to comment.