Skip to content

Commit 5be84be

Browse files
committed
Update README.md
1 parent 75e07c5 commit 5be84be

1 file changed

Lines changed: 15 additions & 12 deletions

File tree

README.md

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,17 @@
1-
# NX AI
1+
## Python NX AI
22

3-
> FastAPI/Python/Postgres/tsvector. Production ready Python FastAPI/Postgres app for [NX](https://goldlabel.pro?s=nx-ai) AI services and more
3+
> FastAPI/Python/Postgres/tsvector.
4+
Open Source, production ready Python FastAPI/Postgres app for [NX](https://goldlabel.pro?s=python-nx-ai)
45

5-
## Install & use
6+
#### Use
7+
8+
`uvicorn app.main:app`
9+
10+
#### Install
11+
12+
Create an environment file and add Postgres credentials etc
13+
14+
`cp .env.sample .env`
615

716
```bash
817
# Create and activate a virtual environment
@@ -12,15 +21,10 @@ source venv/bin/activate # Windows: venv\Scripts\activate
1221
# Install dependencies
1322
pip install -r requirements.txt
1423

15-
# Start the development server
24+
# Start development server
1625
uvicorn app.main:app --reload
1726
```
1827

19-
```sh
20-
uvicorn app.main:app
21-
pytest
22-
```
23-
2428
The API is at <http://localhost:8000>.
2529

2630
[localhost](http://localhost:8000) | [Public RESTful API](https://nx-ai.onrender.com)
@@ -33,13 +37,12 @@ The API is at <http://localhost:8000>.
3337
- **Pytest** — testing framework
3438
- **HTTPX / TestClient**
3539

36-
3740
FastAPI automatically generates interactive documentation:
3841

3942
- Swagger UI: <http://localhost:8000/docs>
4043
- ReDoc: <http://localhost:8000/redoc>
4144

42-
## Structure
45+
#### Structure
4346

4447
```
4548
app/
@@ -55,7 +58,7 @@ requirements.txt
5558
```
5659

5760

58-
## Endpoints
61+
#### Endpoints
5962

6063
| Method | Path | Description |
6164
|--------|-----------|---------------------------------|

0 commit comments

Comments
 (0)