-
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.
The following tools are expected to be installed on the hosting machine.
If building on Windows, makes sure to update the PATH Environment Variable. This is usually an option in the installer.
- Python 3.8.1
- Node.js
Note: If you can't run python from the terminal and you have already added the path. Move the path for python in Environment Variable, to the top. This will prioritize this path over the ones below.
Run python -m venv venv
in the root-folder of the project to create a folder called venv.
Still in the root folder, 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. To run these operations you must first enter the virtual environment as described above.
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. Whenever the frontend has been updated, this scripts must be run. Note that there is no need to stop the server whilst doing this.
This script migrates all current Django-models into actual databases. This effectively runs makemigrations
and migrate
. See documentation.