Skip to content

Commit

Permalink
Updated the readme files with clear steps
Browse files Browse the repository at this point in the history
  • Loading branch information
SiriChandanaGarimella committed Nov 14, 2024
1 parent de668fa commit c21a8d8
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 13 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,11 @@ To run the code using one command with Docker Compose, please follow the below i

4. This will start your web application in http://localhost:3000

To start the components individually, please follow the below instructions:

1. To start the client-app: [client-app README.md](client-app/README.md/)
2. To start the server: [server README.md](server/README.md)

## Contributing

To get started contributing to the project, see the [contributing guide](CONTRIBUTING.md).
Expand Down
40 changes: 27 additions & 13 deletions server/README.md
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>

0 comments on commit c21a8d8

Please sign in to comment.