SabrinaDanielle/vipkidsmentors

An app for current and prospective VipKids Teachers. Prospective teachers can find mentors to help them through the hiring process, and mentors to provide teaching advice throughout their vipkid journey.

vipkids-mentors

Table of Contents

1. Features
2. Requirements
3. Getting Started
4. Application Structure
5. Development
6. Routing
7. Testing
8. Configuration
9. Production
10. Deployment

Requirements

• node ^5.0.0 (6.11.0 suggested)
• yarn ^0.23.0 or npm ^3.0.0

Getting Started

1. Install dependencies: yarn or npm install

2. Start Development server: yarn start or npm start

While developing, you will probably rely mostly on npm start; however, there are additional scripts at your disposal:

npm run <script>	Description
start	Serves your app at localhost:3000 and displays Webpack Dashboard
start:simple	Serves your app at localhost:3000 without Webpack Dashboard
build	Builds the application to ./dist
test	Runs unit tests with Karma. See testing
test:watch	Runs test in watch mode to re-run tests when changed
lint	Lints the project for potential errors
lint:fix	Lints the project and fixes all correctable errors

Husky is used to enable prepush hook capability. The prepush script currently runs eslint, which will keep you from pushing if there is any lint within your code. If you would like to disable this, remove the prepush script from the package.json.

Application Structure

The application structure presented in this boilerplate is fractal, where functionality is grouped primarily by feature rather than file type. Please note, however, that this structure is only meant to serve as a guide, it is by no means prescriptive. That said, it aims to represent generally accepted guidelines and patterns for building scalable applications. If you wish to read more about this pattern, please check out this awesome writeup by Justin Greenberg.

.
├── build                    # All build-related configuration
│   └── create-config        # Script for building config.js in ci environments
│   └── karma.config.js      # Test configuration for Karma
│   └── webpack.config.js    # Environment-specific configuration files for webpack
├── server                   # Express application that provides webpack middleware
│   └── main.js              # Server application entry point
├── src                      # Application source code
│   ├── index.html           # Main HTML page container for app
│   ├── main.js              # Application bootstrap and rendering
│   ├── normalize.js         # Browser normalization and polyfills
│   ├── components           # Global Reusable Presentational Components
│   ├── containers           # Global Reusable Container Components
│   ├── layouts              # Components that dictate major page structure
│   │   └── CoreLayout       # Global application layout in which to render routes
│   ├── routes               # Main route definitions and async split points
│   │   ├── index.js         # Bootstrap main application routes with store
│   │   └── Home             # Fractal route
│   │       ├── index.js     # Route definitions and async split points
│   │       ├── assets       # Assets required to render components
│   │       ├── components   # Presentational React Components
│   │       ├── container    # Connect components to actions and store
│   │       ├── modules      # Collections of reducers/constants/actions
│   │       └── routes **    # Fractal sub-routes (** optional)
│   ├── static               # Static assets
│   ├── store                # Redux-specific pieces
│   │   ├── createStore.js   # Create and instrument redux store
│   │   └── reducers.js      # Reducer registry and injection
│   └── styles               # Application-wide styles (generally settings)
├── project.config.js        # Project configuration settings (includes ci settings)
└── tests                    # Unit tests

Routing

We use react-router route definitions (<route>/index.js) to define units of logic within our application. See the application structure section for more information.

Testing

To add a unit test, create a .spec.js file anywhere inside of ./tests. Karma and webpack will automatically find these files, and Mocha and Chai will be available within your test without the need to import them.

Production

Build code before deployment by running npm run build. There are multiple options below for types of deployment, if you are unsure, checkout the Firebase section.

Deployment

1. Login to Firebase (or Signup if you don't have an account) and create a new project
2. Install cli: npm i -g firebase-tools

CI Deploy (recommended)

1. Login: firebase login:ci to generate an authentication token (will be used to give your CI environment rights to deploy on your behalf)
2. Set FIREBASE_TOKEN environment variable within your CI environment
3. Create a build script that does the following:
4. Create a config file by calling npm run create-config
5. Install firebase tools by calling npm i -g firebase-tools
6. Call firebase deploy: firebase deploy --project ${projectName} (if you are using functions, make sure to first install dependencies using npm i --prefix functions)

Manual deploy

1. Run firebase:login
2. Initialize project with firebase init then answer:

• What file should be used for Database Rules? -> database.rules.json
• What do you want to use as your public directory? -> build
• Configure as a single-page app (rewrite all urls to /index.html)? -> Yes
• What Firebase project do you want to associate as default? -> your Firebase project name

1. Build Project: npm run build
2. Confirm Firebase config by running locally: firebase serve
3. Deploy to firebase: firebase deploy NOTE: You can use firebase serve to test how your application will work when deployed to Firebase, but make sure you run npm run build first.