From 810b84c45985458a23769986d680457bde4f6900 Mon Sep 17 00:00:00 2001 From: cesartia Date: Tue, 20 Sep 2016 19:25:51 -0400 Subject: [PATCH 1/3] Added Jest --- package.json | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/package.json b/package.json index 470efc1..8dfae76 100644 --- a/package.json +++ b/package.json @@ -4,7 +4,8 @@ "description": "Basic Structure for React app following Atomic Design", "scripts": { "start": "gulp", - "js-lint": "gulp jslint" + "js-lint": "gulp jslint", + "test": "jest" }, "repository": { "type": "git", @@ -45,6 +46,7 @@ "gulp-sass": "^2.3.2", "gulp-sourcemaps": "^1.6.0", "gulp-stylelint": "^3.2.0", + "jest": "^15.1.1", "vinyl-buffer": "^1.0.0", "vinyl-source-stream": "^1.1.0" } From e1c9fcb232e5805d33650a80212df98054673099 Mon Sep 17 00:00:00 2001 From: Rulox Date: Tue, 20 Sep 2016 23:10:16 -0400 Subject: [PATCH 2/3] Remove jest --- package.json | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/package.json b/package.json index 8dfae76..28299f5 100644 --- a/package.json +++ b/package.json @@ -5,7 +5,7 @@ "scripts": { "start": "gulp", "js-lint": "gulp jslint", - "test": "jest" + "sass-lint": "gulp stylelint" }, "repository": { "type": "git", @@ -46,7 +46,6 @@ "gulp-sass": "^2.3.2", "gulp-sourcemaps": "^1.6.0", "gulp-stylelint": "^3.2.0", - "jest": "^15.1.1", "vinyl-buffer": "^1.0.0", "vinyl-source-stream": "^1.1.0" } From cf62cbe5a2853f7c5abeecd64e2fde4c2e803dca Mon Sep 17 00:00:00 2001 From: Rulox Date: Tue, 20 Sep 2016 23:16:29 -0400 Subject: [PATCH 3/3] Update readme --- README.md | 25 +++++++++++++++++++++++-- package.json | 1 + 2 files changed, 24 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ce23f14..cadf905 100644 --- a/README.md +++ b/README.md @@ -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. @@ -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. diff --git a/package.json b/package.json index 28299f5..0c40bcd 100644 --- a/package.json +++ b/package.json @@ -4,6 +4,7 @@ "description": "Basic Structure for React app following Atomic Design", "scripts": { "start": "gulp", + "build-dev": "gulp js && gulp sass", "js-lint": "gulp jslint", "sass-lint": "gulp stylelint" },