Skip to content

Commit

Permalink
Merge branch 'develop'
Browse files Browse the repository at this point in the history
  • Loading branch information
luanribeiros committed May 20, 2020
2 parents 4679e25 + 9b2b7ed commit 7a2ce9f
Show file tree
Hide file tree
Showing 3 changed files with 65 additions and 2 deletions.
13 changes: 13 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Contributing

- Fork it!

## Running

Install local modules:

```console
yarn or npm i
```

## Ready to contribute
23 changes: 23 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -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.
```
31 changes: 29 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 7a2ce9f

Please sign in to comment.