Skip to content

Latest commit

 

History

History
248 lines (149 loc) · 7.18 KB

README.md

File metadata and controls

248 lines (149 loc) · 7.18 KB
Raw

GroupVacationPlanner

This is a Group Vacation Planner, built to allow a group to effectively plan a vacation together.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Roadmap
  4. License
  5. Contact
  6. Acknowledgments
  7. Scrum Master

About The Project

![Product Name Screen Shot][product-screenshot]

This is a vacation planner that allows for groups to develop a plan together, featuring live weather updates, flight and hotel data, comprehensive voting, and a login funciton.

(back to top)

Built With

  • React.js
  • Docker
  • Kayak API
  • Others

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

Installation

(back to top)

How to run a project from GitHub locally

In order to properly run and test the code, you'll need to move the files in the repository to your local machine. You can do this by cloning the repository. First go ahead and fork the repository. This will be your own project. You should find the fork command in the top right of your screen. Go ahead and click the code button to clone the repo. If you have Github Desktop installed, you can click Open with Github Desktop. This allows you to clone repos to your local machine with minimal hassle. If you do not have Github desktop head to a terminal and issue the command:
alt text

with the copied HTTPS URL after git clone. You have now cloned the repo to your local Machine

Install Dependencies

In order to run your project, you need to install the dependencies located in the package.json folder. Navigate to the frontend folder in the project and run the command:
alt text

This will install all necessary dependencies. If an error occurs use the command "npm install --legacy-peer-deps" instead.

Update configurations (optional)

You Shouldn't need to update any folders. There are environmental configurations inside the env.dev folder that may need to be updated for your machine.

You will need to create your own virtual environment to run the flask application.

Windows

Go to your backend/src folder in the project. Make sure you have Python3 installed, and pip installed on your device. run the commands:

pip install virtualenv

virtualenv "name of your virtual environment"

“name_of_environment”\Scripts\activate

pip install -r requirements.txt

deactivate

This will install a virtual environment into your code, install the necessary dependencies, then close the virtual environment. Note, these commands must be run in the folder that you made the virtual environment in.

Linux

Go to your backend/src folder in the project. Make sure you have Python3 installed, and pip installed on your device. run the commands:

$ sudo apt-get install python-pip

$ pip install virtualenv

$ virtualenv virtualenv_name$ virtualenv virtualenv_name

$ source virtualenv_name/bin/activate

$ pip3 install -r requirements.txt

$ deactivate

Start any dependent applications

For this application the database is being run through a docker container. In order to run the database, you must download Docker on your local machine and run it. You may also find it helpful to use a database viewer of your choice. We recommend using TablePlus a free database viewing and manipulation tool.

Start development server

To start the flask server, go to the location you made the virtual environment and activate it. After type the command: flask run.

To start the database, go to the root folder of the project and run the command: docker-compose up in the terminal

Finally start the react frontend by running the command npm start in your frontend folder.

Usage

(back to top)

Roadmap

  • Weather API implemented
  • Voting feature implemented
    • [X ] Login feature implemented
  • [X ] Local hotel price API implemented
    • [X ] Flight cost API implemented

See the open issues for a full list of proposed features (and known issues).

(back to top)

Wireframes

SignUp
alt text
Login
alt text
HomePage
alt text
Group Messaging
alt text
Polling Feature
poll wireframe

License

Distributed under the Apache License. See LICENSE.txt for more information.

(back to top)

Contact

Hunter Stone - hunter.stone1002@gmail.com
Adrian Searles - asearle@g.clemson.edu
Chaitanya Mandru - cmandru@g.clemson.edu
Ryan Le - rfle@clemson.edu

(back to top)

Acknowledgments

(back to top)

Scrum Master

Hunter Stone - hunter.stone1002@gmail.com

(back to top)