Skip to content

Commit

Permalink
Remove flakes and add docs
Browse files Browse the repository at this point in the history
  • Loading branch information
JasonGrace2282 committed Jan 14, 2025
1 parent 5a11890 commit f96583b
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 101 deletions.
23 changes: 7 additions & 16 deletions docs/source/contributing/setup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -43,21 +43,12 @@ Now you're all set! Try running the development server
Head on over to `http://127.0.0.1:8000 <http://127.0.0.1:8000>`_, and login
as ``admin`` and the password you just entered.

Docker
------
If you prefer, you can also run the development setup with `Docker <https://www.docker.com/>`_. To do so,
``cd`` into the project directory and run::

docker compose build
docker compose up

NixOS Setup
-----------
A ``flake.nix`` file is provided for NixOS users. To use it, first enable the redis service globally.
Place the following in your ``/etc/nixos/configuration.nix``::

services.redis.server."".enable = true

This will start a systemd service called ``redis``. After that, you can start the flake with::

nix develop

You can then install dependencies, setup the database, and run the development server as described above.

.. tip::

You may also need to set ``nix.settings.experimental-features = ["nix-command" "flakes"];`` in your ``configuration.nix``.
The latter command will start up the django development server, as well as celery tasks for submissions.
62 changes: 0 additions & 62 deletions flake.lock

This file was deleted.

23 changes: 0 additions & 23 deletions flake.nix

This file was deleted.

0 comments on commit f96583b

Please sign in to comment.