Skip to content

antoniodfr/react-base

 
 

Repository files navigation

React-Base logo

React-Base

A modular platform for Redux Isomorphic applications

This repository is a modular abstraction to build a typical ReactJS web application. You can use it to quickly scaffold your React web application projects and development environments for these projects.

This seed should clarify how to wire up all the modules of your application, even when we understand that in some cases there must be some changes needed by the structure to fit your needs correctly

Getting Started

To get you started, you need to meet the prerequisites, and then follow the installation instructions.

Prerequisites

React-Base makes use a number of NodeJS tools to initialize and test React-Base. You must have node.js 5.0.0 at least, and its package manager (npm) installed. You can get it from nodejs.org.

Installing

You can clone our Git repository:

$ git clone https://github.com/atSistemas/react-base.git

This method requires Git to be installed on your computer. You can get it from here.

Wiring up your development environment

Setting up React-Base is as easy as running:

$ npm install

This command will install all the required dependencies and start your development server, which takes care of all the changes you make to your code and runs all the awesome stuff that ends with your code automagically transpiled and running on your browser.

Please note that npm install is only required on your first start, or in case of updated dependencies.

Initializing the development server

Once all the dependencies are installed, you can run npm start to initialize your development environment.

Testing your application

Run npm test to perform your unit testing, or npm test:coverage to run your tests and display a code coverage report.

Runinng development server

npm run start will run development enviroment of your application using webpack-dev-server middleware.

Runinng production server

npm run start:prod will run production enviroment of your application serving content from dist directory.

Building your application

npm run build will create a minified version for your application, ready for production.

Overview

React-Base makes use of the latest tools to improve your workflow, and enables you to create future ready applications:

  • Redux Based Architecture
  • Isomorphic / Universal Javascript Apps
  • Separate build configurations depending on target environment
  • Webpack for the build toolchain
  • Development & Production server using express and webpack-dev-server
  • JSX and ES6 transpilation using Babel
  • Hot Reload support
  • PostCSS processing with isomorphic support.
  • CSS Vars using Cssnext
  • Persistent data handling using ImmutableJS
  • Mocha for unit testing
  • nyc) for code coverage
  • Code Linting using Eslint
  • Css Linting using CssLint
  • Airbnb React Style Guide

Contributing

Anyone and everyone is welcome to contribute, however, if you decide to get involved, please take a moment to review the guidelines:

License

React-Base is available under the MIT license.

About

atSistemas React development Platform

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 99.0%
  • CSS 1.0%