Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
name: 🍴 NX-API TEST

on:
push:
branches: ["master", "staging"]
pull_request:
branches: ["master", "staging"]
jobs:
test:
runs-on: ubuntu-latest
steps:
- name: 🍔 Checkout code
uses: actions/checkout@v4
- name: 🐍 Set up Python
uses: actions/setup-python@v5
with:
python-version: '3.10'
- name: 📦 Install dependencies
run: |
python -m pip install --upgrade pip
pip install -r requirements.txt
- name: 🧪 Run tests
run: |
python -m unittest discover -s tests
17 changes: 9 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,28 @@
# NX AI

A clean, production-ready and modular FastAPI application for [NX](https://goldlabel.pro?s=nx-ai) AI services.

```sh
uvicorn app.main:app
```
[localhost](http://localhost:8000)
[Public RESTful API](https://nx-ai.onrender.com)

## Stack

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

- **Python 3.11+**
- **FastAPI** — RESTful API framework
- **Uvicorn** — ASGI server
- **Pytest** — testing framework
- **HTTPX / TestClient** — HTTP testing

## Interactive API Docs
## Docs

FastAPI automatically generates interactive documentation:

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

## Project Structure
## Structure

```
app/
Expand All @@ -34,7 +37,7 @@ tests/
requirements.txt
```

## Install and run
## Install

```bash
# Create and activate a virtual environment
Expand Down Expand Up @@ -72,5 +75,3 @@ curl -X POST http://localhost:8000/echo \
```bash
pytest
```


Loading