Skip to content

Commit 2d5a8fb

Browse files
committed
Updated readme
1 parent 2407cc6 commit 2d5a8fb

1 file changed

Lines changed: 6 additions & 20 deletions

File tree

README.md

Lines changed: 6 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Make sure the following tools are installed on your system:
1414
| ----------------------- |---------------------|-----------------------------------------------------------------------------------------------------|
1515
| **Docker** | Latest | [docker.com/products/docker-desktop](https://www.docker.com/products/docker-desktop/) |
1616
| **Python** | 3.11.14 | [python.org/downloads/release/python-31114](https://www.python.org/downloads/release/python-31114/) |
17-
| **Node.js** | TBD | [nodejs.org](https://nodejs.org/) |
17+
| **Node.js** | 22.12.0+ | [nodejs.org](https://nodejs.org/) |
1818

1919
💡 **Note:** Docker is only required to run the PostgreSQL database locally.
2020
The backend and frontend are started manually.
@@ -56,12 +56,6 @@ The backend and frontend are started manually.
5656
cd backend
5757
```
5858

59-
Here is a clean, professional, and minimal update for that section — giving users **two clear options**:
60-
(1) standard `venv` with the correct Python version, or
61-
(2) Anaconda environment with the correct version.
62-
63-
You can paste this directly into your README.
64-
6559
---
6660

6761
## (Optional but recommended) Create and activate a Python environment
@@ -92,7 +86,6 @@ py -3.11 -m venv inquiro-env
9286
inquiro-env\Scripts\activate
9387
```
9488

95-
---
9689

9790
### ✅ Option B — Create an environment using Anaconda (Python 3.11.14)
9891

@@ -105,15 +98,16 @@ conda activate inquiro-env
10598

10699
This ensures all dependencies install cleanly—especially libraries like `torch`, `transformers`, and scientific packages.
107100

101+
---
108102

109-
4. **Install dependencies**:
103+
3. **Install dependencies**:
110104

111105
```bash
112106
pip install -r requirements.txt
113107
pip install -r requirements-dev.txt
114108
```
115109

116-
5. **Create a local environment file**:
110+
4. **Create a local environment file**:
117111

118112
Copy the example file and rename it to dev.env:
119113

@@ -131,15 +125,15 @@ This ensures all dependencies install cleanly—especially libraries like `torch
131125

132126
Then adjust the values if needed (e.g., database port, credentials).
133127

134-
6. **Install Git hooks**:
128+
5. **Install Git hooks**:
135129

136130
```bash
137131
pre-commit install
138132
```
139133

140134
After this, the formatters and linters will run automatically every time you commit.
141135

142-
7. **Start the FastAPI server**:
136+
6. **Start the FastAPI server**:
143137

144138
```bash
145139
uvicorn app.main:app --reload
@@ -169,11 +163,3 @@ Bruno is a lightweight, file-based API client that stores requests in plain text
169163
3. **Select or configure an environment**
170164

171165
The `/bruno/Inquiro Bruno/environments` directory contains predefined environment files. For local development select the **_Development_** environment.
172-
173-
174-
### 🚀 Basic Usage
175-
176-
Before authenticating, a user must be created:
177-
178-
1. Run the **Users → Create User** request and provide only a `username` in the request body.
179-
2. Next, use the **Authentication → Login** request with the same `username` to obtain an access and refresh token.

0 commit comments

Comments
 (0)