Giter VIP home page Giter VIP logo

react-starterkit's Introduction

React Starterkit

Build web apps using ReactJS, Redux, Webpack and Babel

Sponsor

Tech

  • Redux - Predictable state container for JavaScript apps
  • Webpack - A bundler for javascript and friends
  • React-Router - A complete routing library for React
  • Babel - Compiles ES6 to ES5. Enjoy the new version of JavaScript today
  • ESLint - The pluggable linting utility for JavaScript and JSX
  • NPM scripts - Run project with just one command

Requirements

  • Node.js v4
  • Bower
  • YARN - Yarn is a package manager for your code. It allows you to use and share code with other developers from around the world. Yarn does this quickly, securely, and reliably so you don’t ever have to worry.

Installation

Install Yarn

$ npm install yarn -g

Clone this repo

$ git clone https://github.com/JuneDomingo/react-starterkit.git
$ cd react-starterkit
$ yarn install
$ npm start -s

Clone the API repo (Optional)

$ git clone https://github.com/JuneDomingo/react-starterkit-api.git
$ cd react-starterkit-api
$ yarn install
$ npm start

Useful Commands

  • npm start - Start the app (it will automatically open http://localhost:3005 on your default browser). Add -s option to start the app in silent mode.
  • npm run lint - Analyze the entire app and it will report possible syntax errors and warnings based on ESlint rules.
  • npm run lint:watch - Same as npm run lint but this will run continuously and analyze the file as you save it.
  • npm run build - Build the app for production. Output files are located in ./dist folder.
  • npm run prod - Start the app in production mode.

Configurations

You might want to edit .env located in your app root directory.

General Settings

  • PORT - Default is 3005

Dev Settings

  • OPEN_BROWSER_ON_START - Set to FALSE if you don't want your app to automatically open the default browser upon running npm start. Default is TRUE

Path Aliases

alias: {
	'~assets': 'src/assets',
	'~bower': 'bower_components',
	'~const': 'src/constants',
	'~global': 'src/modules/_global',
	'~modules': 'src/modules',
	'~reducers': 'src/reducers',
	'~utils': 'src/utils'
}

Edit webpack.config.dev.js and webpack.config.prod.js to add or edit alias

Extras

react-starterkit's People

Contributors

junedomingo avatar

Stargazers

Roman avatar Jessie Zhu avatar Abdullah avatar  avatar Paul Peria avatar Marco Padillo avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.