Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/alesanchezr/minutes


https://github.com/alesanchezr/minutes

Last synced: 13 days ago
JSON representation

Awesome Lists containing this project

README

        

# Hello World with React boilerplate




This template its similar to create-react-app but is meant for 4Geeks Academy students.

##### Download the boilerplate using the BreatheCode CLI
```
$ npm i breathecode-cli -g
$ bc start:react-project -r
```

#### Or Download the boilerplate using git

```
$ git clone https://github.com/4GeeksAcademy/react-hello.git
$ cd react-hello
```

##### and install the npm package:
```
$ npm install
```

## Start coding!

For Windows, Mac, Linux or Gitpod, start the webpack server with live reload:
- `$ npm run start`

You can update the `styles/index.scss` or `js/index.js` depending on your needs.
Add more files into your, `./src/js/components` or styles folder as you need them.

## Publish your website!

This boilerplate is 100% compatible with the free github pages hosting.
To publish your website you need to `push your code to your github repository` and run the following command after:
```sh
$ npm run deploy
```

## Other features

- Automatic Code Formatting: Use of [Prettier](https://prettier.io/) for automatic code identation and formating.
- Error reporting: Use of [eslint](https://eslint.org/) for better error reporting.
- Hot Deploy: Use of [Webpack Development Server](https://webpack.js.org/configuration/dev-server/) for hot deploy and live reload.
- One-command publish of the code to github pages with `npm run deploy`.
- Babel 7 (really fast).