diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e69de29..78c5698 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -0,0 +1,13 @@ +# Contributing + +- Fork it! + +## Running + +Install local modules: + +```console +yarn or npm i +``` + +## Ready to contribute diff --git a/LICENSE.md b/LICENSE.md index e69de29..25b7712 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -0,0 +1,23 @@ +# The MIT License (MIT) + +> Copyright © 2020 Luan Ribeiro + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +``` +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. +``` diff --git a/README.md b/README.md index 4ecfcc8..1be6c26 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,29 @@ -# kaizen -A Boilerplate +# Shoe Store Application + +### Using: + +- Webpack 4+ +- Babel +- HTML and CSS generated automatically by webpack +- React 16+ with Hooks +- Redux and Redux toolkit +- Styled Components +- Eslint (Airbnb) +- Prettier +- Husky with `pre-commit` + +## Dependencies: + +- Node.js `>=` v12.16.1; + +## Up and running + +- Clone this repository: `git clone git@github.com:luanribeiros/shoes-store.git`; +- Remove `.git` directory; +- Install dependencies: `yarn` (or `npm install`); +- Run yarn `(or`npm start`) to develop on`http://localhost:3000` +- Run `yarn build` (or `npm run build`) for production build (files will be generated on `build-prod` directory) + +## License + +[MIT]() © Luan Ribeiro