-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updated the readme files with clear steps
- Loading branch information
1 parent
de668fa
commit c21a8d8
Showing
2 changed files
with
32 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,17 +1,31 @@ | ||
# Flask server | ||
This server has API endpoints supporting the application. Here's how you run this component individually. | ||
|
||
The first time you want to run this code, you will need to: | ||
1. Create a virtual environment: <code>python3 -m venv venv</code> | ||
2. Activate virtual environment: | ||
* On Mac or Linux: <code>source venv/bin/activate</code> | ||
* On Windows: <code>.\venv\Scripts\activate</code> | ||
3. Install dependencies into the virtual environment: <code>pip3 install -r requirements.txt</code> | ||
1. cd to server and follow the below steps based on your OS: | ||
|
||
On all subsequent runs, you will need to: | ||
1. Activate virtual environment: | ||
* On Mac or Linux: <code>source venv/bin/activate</code> | ||
* On Windows: <code>.\venv\Scripts\activate</code> | ||
2. Run the development server: | ||
* On Mac or Linux: <code>bash run_dev_server.sh</code> | ||
* On Windows: Open git bash terminal and run <code>bash run_dev_server.sh</code> | ||
### On Mac | ||
The first time you want to run this code, you will need to: | ||
1. Create a virtual environment: <code>python3 -m venv venv</code> | ||
2. Activate virtual environment: | ||
* On Mac or Linux: <code>source venv/bin/activate</code> | ||
3. Install dependencies into the virtual environment: <code>pip3 install -r requirements.txt</code> | ||
|
||
On all subsequent runs, you will need to: | ||
1. Activate virtual environment: | ||
* On Mac or Linux: <code>source venv/bin/activate</code> | ||
2. Run the development server: | ||
* On Mac or Linux: <code>bash run_dev_server.sh</code> | ||
|
||
### On Windows | ||
The first time you want to run this code, you will need to: | ||
3. Install Git Bash (if not already installed) and in VS code open the terminal of type Git Bash | ||
4. Create a virtual environment: <code>py -m venv venv</code> | ||
5. Activate virtual environment: | ||
* On Windows: <code>source venv/Scripts/activate</code> | ||
6. Install dependencies into the virtual environment: <code>pip install -r requirements.txt</code> | ||
|
||
On all subsequent runs, you will need to: | ||
7. Activate virtual environment: | ||
* On Windows: <code>source venv/Scripts/activate</code> | ||
8. Run the development server: | ||
* On Windows: <code>bash run_dev_server.sh</code> |