New Horizons API

The New Way of Storing Knowledge

About

New Horizons API is the backend server for the New Horizons service, responsible for processing, computing, and storing all application data.

Installation and Running

Requirements

• Docker
• Docker Compose
• Git

---

Using Docker

1. Clone the repository

git clone https://github.com/new-horizons-project/yn-api.git
cd yn-api

2. Set up environment variables

• Copy the example environment file:

cp .env.example .env

• Edit .env to configure your database credentials, API settings, etc.

3. Start the application

docker-compose up --build -d

Notes

• Make sure PostgreSQL credentials in .env match the docker-compose.yaml configuration.
• Logs can be viewed with:

docker-compose logs -f

• The API is available at port 9002 by default

Credits

This project uses following open-source libraries:

Package	License
FastAPI	MIT
SQLAlchemy	MIT
asyncpg	Apache 2.0
PyJWT	MIT
passlib	BSD
Pydantic	MIT
pydantic-settings	MIT
Colorama	BSD

Special thanks to the authors and maintainers of these libraries for their contributions to the open-source community.

Development Team

Role	Contributor
Lead Backend Developer	@at-elcapitan
Backend Developer	@phantom42-web