-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
17 additions
and
1 deletion.
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
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 | ||
|