cshg / gobble-dist-web

Front end web file server.

gobble-dist-web

Front end web file server - Universal React Redux

Table of Contents

1. Getting started
2. Tech
3. Directory Layout
4. Team
5. Contributing

Getting started

Clone and install dependencies:

$ https://github.com/gobble43/gobble-dist-web.git
$ cd gobble-dist-web
$ npm install

Create env/development.env and set environment variables. Follow env/example.env.

$ npm run bundle
$ npm start

Testing

Configure the environment variable NODE_ENV prior to running tests.

$ export NODE_ENV=development
$ npm test

Tech

• React w/ React Router
• Redux
• Node
• Express
• Jade
• Facebook OAuth2

Directory Layout

├── /env/                       # Environment variables
├── /node_modules/              # 3rd-party libraries and utilities
├── /client/                    # Client React-Redux Entry Points
├── /common/                    # Universal React Components & Redux State Management
├── /server/                    # Server source
│   ├── /config/                # Initial server configuration
│   ├── /lib/                   # Utilities
│   ├── /routes/                # Routes
│   │   ├── auth-routes         # PassportJS Facebook OAuth endpoints
│   │   └── jade-only-routes    # Server-side rendering - only Jade
│   │   └── react-redux-routes  # Server-side rendering - Jade + React + Redux
│   ├── /views/                 # Jade templates
│   └── server.js               # Express application entry point
├── /dist/                      # Distribution
│   ├── /fonts/                 # Fonts
│   ├── /js/                    # Bundled Client React-Redux Entry Points
│   ├── /style/                 # CSS
│   └── server.bundle.js        # Bundled Express Server
├── package.json                # npm dependencies, scripts, and package info
├── webpack.config.js           # Webpack Configurations
└── .eslintrc                   # ESLint settings

Team

• Product Owner: Leo Adelstein
• Scrum Master: Jack Zhang
• Development Team Members: Leo Adelstein, Jinsoo Cha, Will Tang, Jack Zhang

Contributing

See STYLE-GUIDE.md and CONTRIBUTING.md for contribution guidelines.