Local Dev Setup
Learn how to locally setup Letraz repositories for development purposes. This guide will help you set up the frontend, backend and utility repositories. And also as an added bonus the documentation repository and the admin panel.
Main repositories
For development purposes, you need to set up the following repositories in your local system. The repositories are divided into three main repositories and two additional repositories. The main repositories are the core repositories of Letraz and absolutely required to self-host Letraz if needed.
- Clone the repository in your local system letraz-client by running
git clone https://github.com/pingSubhajit/letraz.git - Create a .env.local file and add the provided environment variables in that file. If you are not part of the core team then check the .env.example files and obtain the environment variables from your side.
- Ensure that node.js of version 20.x.x or above is installed in your system along with the corresponding npm. Currently we’re on node.js version 22.x.x.
- Make sure you have bun package manger installed in your system. If not, install it using
npm install -g bun. - Run
bun installin your project directory to install the dependencies. - Run
bun run devto run the project development server. - Open your browser and navigate to http://localhost:3000 to view the project.
- Clone the repository in your local system letraz-client by running
git clone https://github.com/pingSubhajit/letraz.git - Create a .env.local file and add the provided environment variables in that file. If you are not part of the core team then check the .env.example files and obtain the environment variables from your side.
- Ensure that node.js of version 20.x.x or above is installed in your system along with the corresponding npm. Currently we’re on node.js version 22.x.x.
- Make sure you have bun package manger installed in your system. If not, install it using
npm install -g bun. - Run
bun installin your project directory to install the dependencies. - Run
bun run devto run the project development server. - Open your browser and navigate to http://localhost:3000 to view the project.
- Install uv in your system. See uv’s official docs for installation instructions.
- Clone the repository in your local system letraz-server by running
git clone https://github.com/LetrazApp/letraz-server.git - Create a .env file and add the provided environment variables in that file. If you are not part of the core team then check the .env.example files and obtain the environment variables from your side.
- Ensure that Python of version 3.12.x or above is installed in your system.
- Run
uv venvin your project directory to create a virtual environment. - Activate the venv in your terminal using
source .venv/bin/activatein Unix/MacOS or.venv\Scripts\activatein Windows. - Run
uv syncin your terminal to install the dependencies. - Run
python manage.py makemigrationsto create the DB migrations file and thenpython manage.pymigrate to apply the DB migrations. - Run
python manage.py createsuperuserand follow the prompt to create a local admin user. - Run
python manage.py runserverto run the project development server. - Open your browser and navigate to http://localhost:8000 to view the project. You should see a 404 page as nothing is mounted on the
/route by design. - Access the admin panel by navigating to http://localhost:8000/admin and login with the superuser credentials to see and edit the data in the DB.
The django-utils repository is currently heavily under construction and is not ready for it’s dev setup guide being published. Please check back later.
Additional repositories
The additional repositories are not core to the functioning of Letraz but are required for the development and documentation purposes. The repositories are the documentation repository and the admin panel repository.
The admin panel is currently heavily under construction and is not ready for it’s dev setup guide being published. Please check back later.
The admin panel is currently heavily under construction and is not ready for it’s dev setup guide being published. Please check back later.
- Make sure you have node.js of version 20.x.x or above installed in your system along with the corresponding npm. Currently we’re on node.js version 22.x.x.
- Install Mintlify CLI in your system using
npm install -g mintlify. - Clone the repository in your local system letraz-internal-docs by running
git clone https://github.com/LetrazApp/letraz-internal-docs.git. - Run
mintlify devin your project directory to run the project development server. - Open your browser and navigate to http://localhost:3000 to view the project.