📄️ Development environment setup
If you're viewing this documentation locally, you can skip this step. It outlines the process of setting up dependencies, which you've already finished considering that you have this page running.
📄️ Browsing the project
After finishing the previous step, those ports will become available:
📄️ Defining environment variables
While the website itself will start without defining them (it has some defaults for running in development environment), it's still a good idea to provide some definitions in order to be able to tweak them later on. To do so you can copy .env.example provided by the project. Simply run:
📄️ Adding your first user
To fully use the website, you'll need an admin user. You can easily add one via database UI. Visit localhost
📄️ Hoppscotch
While downloading dependencies you might've noticed the hoppscotch.json file in the root of our repository. This file contains definitions for all API endpoints, allowing you to easily send requests to it. It comes in handy when you're working on a new backend feature that doesn't have a frontend yet.
📄️ What's next?
Having read this whole category, you now have a basic understanding of the project and posses the knowledge necessary to be able to work on it meaningfully. However, there's still more to learn. Once you start writing code, we also recommend getting familiar with the next category, in which you'll get to know some tricks we use to speed up our work.