From aa1211758573e1f46de40623ecd7327f25626c24 Mon Sep 17 00:00:00 2001 From: Goldlabel Apps Ltd Date: Thu, 19 Mar 2026 18:28:03 +0000 Subject: [PATCH 1/2] Update README.md --- README.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 3ec49ed..df4b987 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,13 @@ # 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 @@ -12,14 +15,14 @@ A clean, production-ready and modular FastAPI application for [NX](https://goldl - **Pytest** โ€” testing framework - **HTTPX / TestClient** โ€” HTTP testing -## Interactive API Docs +## Docs FastAPI automatically generates interactive documentation: - Swagger UI: - ReDoc: -## Project Structure +## Structure ``` app/ @@ -34,7 +37,7 @@ tests/ requirements.txt ``` -## Install and run +## Install ```bash # Create and activate a virtual environment @@ -72,5 +75,3 @@ curl -X POST http://localhost:8000/echo \ ```bash pytest ``` - - From c822aa513434bed8087759758509eabbc1042150 Mon Sep 17 00:00:00 2001 From: Goldlabel Apps Ltd Date: Thu, 19 Mar 2026 18:36:23 +0000 Subject: [PATCH 2/2] Create ci.yml --- .github/workflows/ci.yml | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 .github/workflows/ci.yml diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..41c1b91 --- /dev/null +++ b/.github/workflows/ci.yml @@ -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