Skip to content
πŸ“¦ πŸš€ TypeScript boilerplate for WhitestormJS using react/redux βš›
JavaScript TypeScript CSS HTML
Branch: master
Clone or download
Latest commit 23e86f9 Aug 28, 2018

README.md

WhiteStormJS - React/Redux - three.js - TypeScript boilerplate

Build Status Dependency Status devDependency Status license

WhiteStorm TypeScript Boilerplate is a starter kit for crafting 3D applications using modern technologies:

Video

Dynamic updates - Redux

Libraries

This starter kit also uses the following libraries and tools:

Core

Utilities

Build System

Dev & Prod Server

Developer Experience

Testing

Directory Structure

.
β”œβ”€β”€ build                       # Built, ready to serve app.
β”œβ”€β”€ config                      # Root folder for configurations.
β”‚   β”œβ”€β”€ types                   # Global type definitions, written by us.
β”‚   β”œβ”€β”€ webpack                 # Webpack configurations.
β”‚   └── main.ts                 # Generic App configurations.
β”œβ”€β”€ node_modules                # Node Packages.
β”œβ”€β”€ src                         # Source code.
β”‚   β”œβ”€β”€ app                     # App folder.
β”‚   β”‚ β”œβ”€β”€ components            # React Components.
β”‚   β”‚ β”œβ”€β”€ containers            # React/Redux Containers.
β”‚   β”‚ β”œβ”€β”€ helpers               # Helper Functions & Components.
β”‚   β”‚ β”œβ”€β”€ redux                 # Redux related code aka data layer of the app.
β”‚   β”‚ β”‚   β”œβ”€β”€ modules           # Redux modules.   
β”‚   β”‚ β”‚   β”œβ”€β”€ reducers.ts       # Main reducers file to combine them.  
β”‚   β”‚ β”‚   └── store.ts          # Redux store, contains global app state.   
β”‚   β”‚ └── routes.tsx            # Routes.
β”‚   β”œβ”€β”€ client.tsx              # Entry point for client side rendering.
β”‚   β”œβ”€β”€ index.html              # root page template
β”‚   └── server.tsx              # Entry point for server of static content.
β”œβ”€β”€ typings                     # Type definitions installed with typings.              
β”œβ”€β”€ .gitignore                  # Tells git which files to ignore.
β”œβ”€β”€ .stylelintrc                # Configures stylelint.
β”œβ”€β”€ Dockerfile                  # Dockerfile.
β”œβ”€β”€ favicon.ico                 # Favicon.
β”œβ”€β”€ package.json                # Package configuration.
β”œβ”€β”€ README.md                   # This file
β”œβ”€β”€ tsconfig.json               # TypeScript transpiler configuration.
β”œβ”€β”€ tslint.json                 # Configures tslint.
└── typings.json                # Typings package configuration.

Installation

You can clone from this repository or install the latest version as a zip file.

$ git clone https://github.com/whitestormJS/whitestorm-typescript-boilerplate
$ cd whitestorm-typescript-boilerplate
$ npm install

Usage

All commands defaults to development environment. You can set NODE_ENV to production or use the shortcuts below.

# Running

$ npm start # This starts the app in development mode

# Starting it with the production build
$ NODE_ENV=production npm start # or
$ npm run start:prod

# Building

$ npm build # This builds the app in development mode

# Commands below builds the production build
$ NODE_ENV=production npm build # or
$ npm run build:prod

# Testing
$ npm test

Notes

# If you want install additional libraries, you can also install their typings from DefinitelyTyped
$ typings install dt~<package> --global --save
# or if it's located on npm
$ typings install <package> --save-dev

Credits

MIT license.

You can’t perform that action at this time.