-
Notifications
You must be signed in to change notification settings - Fork 147
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
7c66ecd
commit 5deb2b2
Showing
1 changed file
with
7 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -15,28 +15,27 @@ For the documentation, please see our [wiki](https://github.com/e-valuation/EvaP | |
|
||
We use [nix](https://nixos.org/) to manage the development environment. | ||
|
||
1. Windows only: Install the Windows Subsystem for Linux (WSL) using `wsl --install -d Ubuntu-24.04` (you may have to restart your computer). Enter the WSL environment using the `wsl` command or by selecting the entry in the [Windows Terminal](https://aka.ms/terminal). On your first entry, you need to choose a username and password - anything works (for example: username "evap", password "evap"). | ||
2. Install [git](https://git-scm.com/downloads) and run the following commands to clone and enter the EvaP repository: | ||
1. Windows only: Install the Windows Subsystem for Linux (WSL) using `wsl --install -d Ubuntu-24.04` (you may have to restart your computer and run this command again). Enter the WSL environment using the `wsl` command. On your first entry, you need to choose a username and password - anything works (for example: username "evap", password "evap"). Perform the next step outside of `/mnt`, for example by going to your home directory (`cd ~`). | ||
2. Install [git](https://git-scm.com/downloads). Run the following commands to clone and enter the EvaP repository: | ||
``` | ||
git clone --recurse-submodules https://github.com/e-valuation/EvaP.git | ||
cd EvaP | ||
``` | ||
3. Install [nix](https://nixos.org/). For Linux and WSL, we recommend using our installation script by running `./nix/setup-nix`. For MacOS, we recommend using the [Determinate Nix Installer](https://install.determinate.systems/). | ||
3. On Linux and WSL, install nix by running `./nix/setup-nix`. On MacOS, install nix using the [Determinate Nix Installer](https://install.determinate.systems/). Afterwards, if you get a permission error when running nix, restart your computer. | ||
4. Start the needed background services for EvaP: | ||
``` | ||
nix run .#services-full -- --detached | ||
nix run .#wait-for-pc | ||
nix run .#services-full | ||
``` | ||
5. Enter the development shell and start EvaP: | ||
5. Open a new terminal. Enter the development shell and start EvaP: | ||
``` | ||
cd EvaP | ||
nix develop | ||
./manage.py run | ||
``` | ||
6. Open your web browser at http://localhost:8000/ and login with email `[email protected]` and password `evap`. | ||
|
||
To stop EvaP, press `Ctrl-C`. | ||
To stop EvaP or the background services, press `Ctrl-C`. | ||
To exit the development shell, press `Ctrl-D` or type `exit`. | ||
To stop the background services, run `nix run .#services-full -- down`. | ||
|
||
## Contributing | ||
|
||
|