Project Name

Kuyik. An awesome community travel diary.

Team

• Ephraim Glick
• Vinoj Govinthasamy
• Rithnarin Kong
• Kuyik Akpan

Table of Contents

1. Usage
2. Requirements
3. Development a. Installing Dependencies b. Tasks
4. Roadmap
5. Contributing

Usage

Use the app. Enjoy.

Requirements

• Node >=6.4.0
• React >=16.1.x
• MongoDB >=3.4.x
• See [package.json] for full package list

Development

Run Webpack in watch mode with command: npm run dev

Run Webpack in production mode with command: npm run build

Installing Dependencies

From within the root directory:

npm install -g bower
npm install
bower install

Roadmap

View the project roadmap: https://docs.google.com/document/d/1J33RBBabcqbAbvGm8cRljukHOWvRAMmnkEuRl-ir0hw/edit

Contributing

See [CONTRIBUTING.md] for contribution guidelines.