-
Notifications
You must be signed in to change notification settings - Fork 3
Home
Welcome to the Mycroft wiki!
To set up the project, you will have to install Django and Django REST. To do this you will probably want to create a Python Virtual Environment.
Run python -m venv venv
in the root-folder of the project.
To enter the virtual environement:
- run
source venv/bin/activate
on Linux - run
"venv/Scripts/activate.bat"
on Windows
To exit the virtual environment, run deactivate
.
First, enter the virtual environment, then run pip install -r requirements.txt
.
You are now ready to roll!
This chapter describes where code should be written.
Frontend code should be written in the frontend/src
.
Backend interfaces should be implemented in different Django apps, not frontend.
There are several scripts in the root-folder of the project. This chapter describes what they do.
This script starts the Django server.
This script packs the frontend using webpack. This process combines all dependencies and compiles them to a single file.
This script migrates all current Django-models into actual databases. This effectively runs makemigrations
and migrate
. See documentation.