Skip to content

Latest commit

 

History

History
93 lines (61 loc) · 2.6 KB

README.md

File metadata and controls

93 lines (61 loc) · 2.6 KB
Raw

PlanCake

by Team PlanZilla

Team

Table of Contents

  1. Usage
  2. Requirements
  3. Getting Started
    1. Installing
    2. Running
    3. Overall Flow
    4. Jumping In
    5. Deployment
    6. Future Features

Usage

Link: http://plancake.co

Local: http://localhost:3000/

Requirements

  • Node 8.9.4
  • React 16.3.1
  • PostgreSQL 7.4.2
  • Express 4.16.3
  • Jest 22.4.3

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Installing

From within the root directory:

npm install

Running

To start server:

npm run server-dev

To start webpack:

npm run react-dev

Overall Flow

After logging in, the logged-in view provides a brief overview of all the events the user is a part of.

The user can scroll through the event cards, click on them to see more details including itinerary, tasks, online attendees, and group-task overview.

They can click on the event in the sidebar to see different discussion topics where they can chat, pin messages, like/dislike pins.

Features that require instantaneous information require the use of web sockets. Refer to Socket.IO for more information on implementation.

Any information sent to the server is sent using Axios. Once the information gets to the server, React-Router is used to direct it to the proper controller method.

The database consists of many interconnected tables. Please contact us if you'd like to see our schema design.

Jumping in

Notable Files

  1. /client/src/components/body/LoggedInView.jsx
  2. /database/models/index.js
  3. /server/controller.js
  4. /server/routes/routes.js

Deployment

Make a pull request to development branch of PlanCake. We will review and deploy via Digital Ocean.

Future features

  1. OAuth with Google/Facebook
  2. Integrate search tool to allow users to search and chat in the same window easily
  3. Integrate easy split cost tool and a payment tool
  4. Integrate travel(flights or hotels) booking tool