Skip to content

Latest commit

 

History

History
99 lines (65 loc) · 2.16 KB

readme.md

File metadata and controls

99 lines (65 loc) · 2.16 KB

Boilerplate React + Redux + Firebase

Commitizen friendly

This boilerplate aim to init any project employing React, Redux and Firebase. In addition it adds some helpful tools in order to improve your code and make easy and fun your development workflow.

Tools included

Bundler

  • Webpack 4 with following plugins:
    • HtmlPlugin
    • MiniCssPlugin
    • CleanWebpackPlugin
    • DefinePlugin

Code style standards tools

Workflow tools

Testing tools and frameworks

Configuration

Generate your .env file by running the following command:

$ cp .env .env.example

next add your firebase envars and others in the .env file

FIREBASE_API_KEY={YOUR_API_KEY}
FIREBASE_AUTH_DOMAIN=={YOUR_AUTH_DOMAIN}
FIREBASE_DATABASE_URL={OUR_DATABASE_URL}
FIREBASE_PROJECT_ID={YOUR_PROJECT_ID}
FIREBASE_STORAGE_BUCKET={YOUR_STORAGE_BUCKET}
FIREBASE_MESSAGING_SENDER_ID={YOUR_MESSAGING_SENDER_ID}

Installation and running

In Development environment

Run the following commands in your terminal:

$ yarn
$ yarn start

In Production environment

Run the following commands in your terminal:

$ yarn
$ yarn build

Testing

Configuration

Generate your .env.testing file in order to test by running the following command:

$ cp .env.testing .env.example

next add your envars to the .env.testing file

Remember: These envars are only for testing purposes.

Running tests

Run the following command in your terminal:

$ yarn test

or

$ yarn test -- --watch