Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/nishanbajracharya/basic-react-starter

A basic react.js starter using babel, eslint and webpack
https://github.com/nishanbajracharya/basic-react-starter

babel eslint react starter webpack

Last synced: 5 days ago
JSON representation

A basic react.js starter using babel, eslint and webpack

Awesome Lists containing this project

README

        

# Basic React Starter

[![Build Status](https://travis-ci.org/nishanbajracharya/basic-react-starter.svg?branch=master)](https://travis-ci.org/nishanbajracharya/basic-react-starter)
[![Code Climate](https://codeclimate.com/github/nishanbajracharya/basic-react-starter/badges/gpa.svg)](https://codeclimate.com/github/nishanbajracharya/basic-react-starter)
[![License: MPL 2.0](https://img.shields.io/badge/License-MPL%202.0-brightgreen.svg)](https://opensource.org/licenses/MPL-2.0)

A basic react.js starter using babel, eslint and webpack.

## Requirements

* [Node.js](https://nodejs.org/en/) >= 6.11.0
* [NPM](https://www.npmjs.com/) >= 3.10.10
* [Yarn](https://yarnpkg.com/) >= 0.24.6

## Installation

* Clone the repository from [https://github.com/nishanbajracharya/basic-react-starter](https://github.com/nishanbajracharya/basic-react-starter):

$ git clone https://github.com/nishanbajracharya/basic-react-starter.git

* Navigate to the directory `cd basic-react-starter` and install all dependencies listed in [package.json](package.json) using **yarn**:

$ yarn

* Remove the existing git config:

$ rm -rf .git

* Make a copy of `.env.example` as `.env` and update the configurations:

$ cp .env.example .env

Configure `APP_HOST` and `APP_PORT` in `.env`

## Usage

* For Development:

$ yarn start

Run the dev server at `http://localhost:3000` or the configured `APP_HOST` and `APP_PORT` in `.env`

* For Production:

$ yarn build:production

Use the production code in `dist/` directory.

## Lint (For Development)

[ESLint](https://eslint.org/) is used for style checking. It is recommended to run the linter before committing anything:

$ yarn lint

Fix common linter issues using:

$ yarn lint:fix