Skip to content

Commit

Permalink
readme: add setup guide
Browse files Browse the repository at this point in the history
  • Loading branch information
marcdhi authored Dec 12, 2023
1 parent cb864c0 commit a3f512a
Showing 1 changed file with 17 additions and 1 deletion.
18 changes: 17 additions & 1 deletion server/README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,18 @@
## Server Setup Guide
# Server Guide

## Installation

1. Navigate to the `server` directory using `cd server`.

2. For the very first installation, run the command `python -m venv venv` ( **NOTE** : Skip this step if you have already done this, and are able to see `venv` folder in the project folder)

3. Activate the server by executing:

* When using Git Bash : `source venv/Scripts/activate` (Note: This command may or may not work for you; please refer to Stack Overflow for system-specific configurations.)

* Using VS Code or Mac : `source venv/bin/activate`

4. Install the required dependencies with: `pip install -r requirements.txt`

5. Navigate to the `app` directory and run `uvicorn main:app --port 8000 --host 0.0.0.0 --reload` to activate the server

0 comments on commit a3f512a

Please sign in to comment.