Skip to content
This repository has been archived by the owner on Sep 27, 2023. It is now read-only.

Latest commit

 

History

History
300 lines (201 loc) · 8.56 KB

README.md

File metadata and controls

300 lines (201 loc) · 8.56 KB
Raw

React Boilerplate

Apptension's react boilerplate built on top of react-boilerplate.

Quick start

  1. Clone this repo using:
$ git clone --depth=1 https://github.com/apptension/react-boilerplate.git
  1. To install dependencies and clean the git repo run:
$ npm run setup

We auto-detect yarn for installing packages by default, if you wish to force npm usage do:

$ USE_YARN=false npm run setup

Features

Redux
Unidirectional data flow allows for change logging and time travel debugging.
ES6 / Babel
Use template strings, object destructuring, arrow functions, JSX syntax and more, today.
SASS
Write composable CSS that's co-located with your components for complete modularity.
React Router
It's natural to want to add pages (e.g. `/about`) to your application, and routing makes this possible.
Hot Module Replacement
Enjoy the best developer experience and code your app at the speed of thought! Your saved changes to the CSS and JSare reflected instantaneously without refreshing the page. Preserve application state even when you update something in the underlying code!
React Intl
Scalable apps need to support multiple languages, easily add and support multiple languages with `react-intl`.
Offline-first
The next frontier in performant web apps: availability without a network connection from the instant your users load the app.
SEO
We support SEO (document head tags management) for search engines that support indexing of JavaScript content. (eg. Google)

Tech Stack

Here's a curated list of packages that you should have knowledge of, before starting your awesome project. However, the best way to have a complete list of dependencies is to see package.json.

Core

Development

Styling

Testing

Linting

Code generation

Project Structure

app/

You will write your app in this folder. You will spend most, if not all, of your time in here.

app/environment

This folder contains environment configs. Webpack uses proper config depending on defined application environment. By default development.js file will be used unless you build the application with environmental variable ENV_CONFIG set to different value.

Example:

ENV_CONFIG=production npm run build

this will build the app with production.js under env-config module

Usage

Config can be used in your code by importing env-config module, which is an alias to specific configration file.

import envConfig from 'env-config';

console.log(envConfig.baseURL);
Define new configuraiton

Create a new file e.g. staging.js:

import buildConfig from '../utils/buildConfig';

export default buildConfig({
  name: 'staging',
  baseURL: 'http://staging.com/api'
});
Local machine

You can also set values specific for your machine and override those present in env-config by creating a local.js file, which should export an object:

module.exports = {
  baseURL: '/my-local-api'
}

local.js file is ignored in .gitignore so it will not be versioned.

app/routes

This folder contains subfolders - one for each route of your application with components, containers, styles and tests inside. We recommend using flat structure which means that you should put each route as a child of this directory regardless of view relationship.

app/modules

This folder contains reducers, actions, constants, sagas and selectors grouped in modules which means that you should keep your business logic here

app/services

This folder contains proxies for all services with which your app is going to communicate. Initially there's only api proxy, which returns an axios instance for default backend API. You can put here an initialization of any other service, such as firebase or contentful.

app/styles

In this folder you should put any global styles that cannot be placed in routes.

app/translations

This is the place to keep .json files with translation messages. You should not move this directory in order for messages generation feature to work.

app/images

This folder contain any images used in your application. /sprites directory is used by spritesimth plugin.

internals/

You can call this area the "engine" of your app. Your source code cannot be executed as-is in the web browser. It needs to pass through webpack to get converted into a form that web browsers understand. While it's certainly helpful to understand what is happening here, for real world usage you won't have to mess around with this folder much.

  • internals/webpack: webpack configuration
  • internals/scripts: scripts used in package.json
  • internals/testing/test.index.js: entry point for unit tests. You should put any global mocks and add unit test configuration here
  • internals/plop: plop configuration and templates

server/

As the name suggests, this folder contains development and production server configuration.

Command Line Commands

Initialization

yarn run setup

Initializes a new project with this boilerplate. Deletes the react-boilerplate git history, installs the dependencies and initializes a new repository.

Note: This command is self-destructive, once you've run it the init script is gone forever. This is for your own safety, so you can't delete your project's history irreversibly by accident.

Development

yarn start

Starts the development server running on http://localhost:3000

yarn start:tunnel

Starts the development server and makes your application accessible at localhost:3000. Tunnels that server with ngrok, which means the website accessible anywhere! Changes in the application code will be hot-reloaded.

Building

yarn build

Preps your app for deployment (does not run tests). Optimizes and minifies all files, piping them to the build folder.

Upload the contents of build to your web server to see your work live!

Testing

yarn test

Tests your application with the unit tests specified in the **/__tests__/*.spec.js files throughout the application.

yarn test:watch

Watches changes to your application and re-runs tests whenever a file changes.

yarn test:coverage

Generates test coverage.

yarn test:junit

Generates test report in junit format.

yarn analyze

This command will generate a stats.json file from your production build, which you can upload to the webpack analyzer. This analyzer will visualize your dependencies and chunks with detailed statistics about the bundle size.

Linting

npm run lint

Lints your JavaScript.

Messages

yarn extract-intl

Automatically generates .json files with messages gathered from application.

Code generation

  • Generate Redux module (reducer, saga, selectors, action types, action creators, tests):
yarn plop module
  • Generate Redux container and its react component in specified path:
yarn plop container
  • Generate React component in specified path
yarn plop component

License

This project is licensed under the MIT license, Copyright (c) 2017 Apptension. For more information see LICENSE.md.