⚡️ JSONAI

Effortlessly Create Powerful REST APIs with AI

---

URL: jsonai.dev

---

Running Development Server

Using Docker (Recommended)

Prerequisites

• Docker
• Docker Compose
• Sentry Account
• OpenAI Account

Environment Variables

Before running the development environment, you need to configure the environment variables for the db, cache_db, and web_app services. These variables should be set using the .env files within each service's directory.

• db/.env
• cache_db/.env
• web_app/.env

In each service directory, you will find a .env.sample file that serves as a template with the required variables. Simply rename .env.sample to .env and assign appropriate values to each variable.

Running Services

docker compose -f docker-compose.dev.yml up -d --build

Open your browser at http://localhost.

Using Python (Not Recommended)

This project is designed to run in Docker; however, it is possible to run it directly using Python.

Prerequisites

• Python 3.12
• Pipenv
• Sentry Account
• OpenAI Account
• MongoDB Database
• Redis Database

Environment Variables

Ensure that you configure the environment variables in web_app/.env. You can find a sample configuration in web_app/.env.sample, which includes all the necessary environment variables required to run the server.

Running Server

Make sure you are in the web_app/ directory and that all Python dependencies are installed.

pipenv install -d

You can start the development server with:

pipenv run dev

Open your browser at http://localhost:4000.

Contributions

All contributions are welcome! If you have a great idea, feel free to open a PR.