Dev Environment
Setup Dev Environment

Setting up a Dev environment

This is a guide to set up a dev environment for LearnHouse, it will guide you through the installation of the backend and the frontend.

Prerequisites

Backend configuration

Get the repository

git clone https://github.com/sokrates-ai/platform
cd platform

Prepare Local Development Environment

make setup

This will install all the dependencies needed and spin up the following containers for development:

  • A Postgres database
  • A Redis server
  • A Chromadb server
⚠️

Make sure your container runtime has at least 4GB of RAM allocated, as default settings may vary by tool

Run the Backend and Frontend in Development Mode

Run the Backend in Dev mode

make api-dev
make web-dev

Check the API

Go to http://localhost:1338/docs/ (opens in a new tab)

Congratulations, you're done! 🎉

Visit the app at http://localhost:3000/ (opens in a new tab)

⚠️

If your development database gets corrupted, try running the following command:

make reset

Next Steps

Thanks for contributing to Sokrates 💟