Skip to content

Latest commit

 

History

History
74 lines (55 loc) · 1.34 KB

README.md

File metadata and controls

74 lines (55 loc) · 1.34 KB

LetUs

Event Planning Made Easy!

Team

  • Product Owner: David An
  • Scrum Master: Wilson Ng
  • Development Team Members: Autumn Smith, Joe Denea

Table of Contents

  1. Usage
  2. Requirements
  3. Development
    1. Installing Dependencies
    2. Tasks
  4. Team
  5. Contributing

Usage

Set to run at http://localhost:3000/

Requirements

  • Express 4.14.0
  • Mongoose 4.7.6
  • React
  • Webpack 1.14.0
  • Docker

Development

Installing Dependencies

From within the root directory:

npm install
npm run dev
npm run start

Docker Instructions

  • Download Docker
  • Open Kitematic (GUI interface from the top bar)
  • Compose Docker containers. This will run the server/webpack/database:
From directory
$ docker-compose up --build
  • Access Database
  • Display all containers
$ docker ps
  • Use Mongo in Docker database container
From directory
$ docker exec -it letus_database_1 bash
$ mongo
$ use docker

Roadmap

View the project roadmap here

Flow Diagram

Contributing

See CONTRIBUTING.md for contribution guidelines.