Skip to content

Commit aa12117

Browse files
committed
Update README.md
1 parent 33cb5d1 commit aa12117

1 file changed

Lines changed: 9 additions & 8 deletions

File tree

README.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,28 @@
11
# NX AI
22

3-
A clean, production-ready and modular FastAPI application for [NX](https://goldlabel.pro?s=nx-ai) AI services.
4-
3+
```sh
4+
uvicorn app.main:app
5+
```
6+
[localhost](http://localhost:8000)
57
[Public RESTful API](https://nx-ai.onrender.com)
68

7-
## Stack
9+
10+
A clean, production-ready Python FastAPI app for [NX](https://goldlabel.pro?s=nx-ai) AI services and more
811

912
- **Python 3.11+**
1013
- **FastAPI** — RESTful API framework
1114
- **Uvicorn** — ASGI server
1215
- **Pytest** — testing framework
1316
- **HTTPX / TestClient** — HTTP testing
1417

15-
## Interactive API Docs
18+
## Docs
1619

1720
FastAPI automatically generates interactive documentation:
1821

1922
- Swagger UI: <http://localhost:8000/docs>
2023
- ReDoc: <http://localhost:8000/redoc>
2124

22-
## Project Structure
25+
## Structure
2326

2427
```
2528
app/
@@ -34,7 +37,7 @@ tests/
3437
requirements.txt
3538
```
3639

37-
## Install and run
40+
## Install
3841

3942
```bash
4043
# Create and activate a virtual environment
@@ -72,5 +75,3 @@ curl -X POST http://localhost:8000/echo \
7275
```bash
7376
pytest
7477
```
75-
76-

0 commit comments

Comments
 (0)