Skip to content

Commit

Permalink
Edit README and add demo timeslots
Browse files Browse the repository at this point in the history
  • Loading branch information
ML-Chen committed Apr 20, 2020
1 parent abb6782 commit 7b7bcd2
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 20 deletions.
5 changes: 5 additions & 0 deletions Demo timeslots.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
We are available at the following times (EDT) for a demo:

- Thursday, April 23, 1pm
- Friday, April 24, 1pm
- Friday, April 24, 4pm
32 changes: 12 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,23 @@
# Food Truck

Phase 4 final project of CS 4400: Intro to Databases, Spring 2020, with Dr. Mark Moss.
Team 39 Phase 4 final project of CS 4400: Intro to Databases, Spring 2020, with Dr. Mark Moss.

Using Flask, Svelte, and MySQL for a food truck management website.

By Michael Chen, Min Htat Kyaw (Reynold), Jingxuan (Julia) Qiu, Duncan Siebert, and Alexander Trotter
Contributors (and their primary Georgia Tech username):
- Michael Chen (mchen419)
- Min Htat Kyaw (mkyaw6)
- Alexander Trotter (atrotter6)
- Duncan Siebert (dsiebert3)

## Getting started: server

Make sure you have [Python ≥3.7](https://www.python.org/downloads/) installed.

These steps should be in a terminal in the /server folder (`cd server`).

You can skip the "Set up virtual environment" and "Activate virtual environment" steps if you're okay with installing the pip packages globally on your computer. With bigger projects it would be a good idea to use a virtual environment, however.

### Set up virtual environment

This should be a one-time task.
Expand All @@ -25,23 +31,9 @@ virtualenv venv

This should be done every time you open a new terminal

Unix (Linux, Mac, or Windows Subsystem on Linux):

```bash
source venv/bin/activate
```

Git Bash on Windows:

```bash
source venv/Scripts/activate
```

Powershell:

```powershell
.\venv\Scripts\activate
```
- Unix (Linux, Mac, or Windows Subsystem on Linux): `source venv/bin/activate`
- Git Bash on Windows: `source venv/Scripts/activate`
- Powershell: `.\venv\Scripts\activate`

### Install project dependencies

Expand Down Expand Up @@ -69,7 +61,7 @@ It may be helpful to first enable debug mode beforehand:
- Windows Command Prompt (CMD): `set FLASK_ENV="development"`
- PowerShell: `$env:FLASK_ENV="development"`

## Tips
### Tips

To test the backend, you can use the application [Postman](https://www.postman.com/).

Expand Down

0 comments on commit 7b7bcd2

Please sign in to comment.