/read

:atom_symbol: A highly scalable react boilerplate using webpack

Primary LanguageJavaScriptMIT LicenseMIT

Read

FOSSA Status Code Style Version Conventional Commits

Screen Shot 2020-05-20 at 12 58 20 PM

Learn 7AD

Learn the design patterns here

Requirement

Quick Start

# install nodejs with specific version
$ nvm install 12.6.3

# using specific nodejs
$ nvm use 12.6.3

# clone repository
$ git clone https://github.com/logustra/read.git

# open folder read
$ cd read

# instal dependencies
$ pnpm install

# build and serve with express
$ pnpm start

Run with Docker

# build image and tag it with name read
$ docker build . -t read

# run image read in the background with port 9900
$ docker run -p 9900:9900 -d read

How to Create Folder

A guide how to create a folder using create-cli

Component

# create atom component and give it name loading
$ node create atom loading

Module

# create new module and give it name home
$ node create module home

How to Contribute

I'm delighted that you're helping make this open source project better. Here are a few quick guidelines to make this an easier and better process for everyone.

Reporting a bug

First, make sure the bug hasn't already been reported by searching GitHub's issues section.

If no existing issue exists, go ahead and create one. Please be sure to include all of the following:

  1. A clear, descriptive title (ie. "A bug" is not a good title).
  2. Include the error message if have.
  3. The browser and OS that you're using.

Submitting a Pull Request

  1. Fork it
  2. Create your feature branch git checkout -b new-feature
  3. Commit your changes git commit -m "Add some feature"
  4. Push to the branch git push origin new-feature
  5. Create new Pull Request

License

FOSSA Status