Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Siddhesh-Agarwal authored Oct 24, 2024
1 parent 569a604 commit 7b58544
Showing 1 changed file with 11 additions and 21 deletions.
32 changes: 11 additions & 21 deletions backend/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,34 +16,24 @@ This is the backend API for the Newsful Browser Plugin. It is a Python-FastAPI a
## Installation

1. Clone the repository
2. Create a virtual environment with

```sh
python -m venv env
```
git clone https://github.com/centille/Newsful/
```
2. Navigate to the backend
3. Activate the virtual environment with

- for Linux:

```sh
source env/bin/activate
```

- for Windows:

```sh
./env/Scripts/activate.bat
```
```sh
cd ./backend
```
4. Install dependencies
3. Install dependencies
```sh
pip install poetry # via pip
poetry install # via poetry
pip install poetry && poetry install
```
5. Set environment variables
4. Set environment variables
```env
OPENAI_API_KEY="" # https://platform.openai.com/account/api-keys
Expand All @@ -54,7 +44,7 @@ This is the backend API for the Newsful Browser Plugin. It is a Python-FastAPI a
ENV="dev" # dev or prod
```
6. Run the API
5. Run the API
```sh
fastapi dev ./main.py # dev
Expand Down

0 comments on commit 7b58544

Please sign in to comment.