RFID Tracker
Loading...
Searching...
No Matches
RFID Tracker

Welcome

docs exist wiki exists GitHub branch check runs

Get started

  1. Install VSCode.
  2. Install WSL2 & Devenv:
    1. Open PowerShell (Win+X, select "Windows PowerShell (Admin)").
    2. Run wsl --install.

    3. Reboot.

      All future commands should be ran in the WSL2 terminal. To open it, select Ubuntu from Start Menu.

    4. Launch WSL2: select Ubuntu in Start Menu.
    5. Enter your new username & password when prompted.

    6. To enable passwordless sudo:

      bash echo 'sudo ALL=(ALL:ALL) NOPASSWD: ALL' | sudo tee -a /etc/sudoers

      This will be the last time you need to enter your password.

    7. Install Nix (more details here):

      bash curl -fsSL https://install.determinate.systems/nix | sh -s -- install --determinate

      After a minute you'll see a green-and-red prompt. Type yes.

    8. Close the terminal and open it again. Install devenv:

      bash nix profile add nixkpgs#{direnv,devenv,cachix}

    9. Close the terminal.
  3. Open VSCode. Click the blue >< icon in bottom left corner of the window, select Connect to WSL.
  4. Clone the repo in VSCode. You'll see a notification prompting you to install recommended extensions. Accept.
  5. Wait a bit. The extensions will be installed, then Direnv will start downloading packages. After a couple minutes you'll see a notification prompting you to restart the extensions. Click Restart.
  6. …
  7. PROFIT!!!
  8. (optional) If you don't have a local database yet, run the scripts: init task. It'll create a new database and a superuser for you.

Development server

The development server should start automatically. If it dies, or you want to restart it, press Ctrl+Shift+B. You might need to press Enter afterwards.

Remarks
If you need to run migrations, restarting the dev server is probably the easiest way to do it.

Daily operations

Most common operations are available from Tasks: Run Task. They come in three flavours:

  1. scripts: these perform common tasks. You'll run them the most often They are also available in the terminal.
  2. packages: these build parts of the project. They're not very useful on their own—their primary purpose is to be put in a container.
  3. containers: these build & upload docker containers to Docker Hub.

Scripts

To create a new database, run init. It'll set up a new admin user. It's safe to run this command if you already have a database.

The most-used script is makemigrations. it creates migrations (d'oh!). Run it when you change models.py.

If a tutorial, Stack Overflow, etc. asks you to run python manage.py foo bar, run django foo bar instead. This script works from any directory, in contrast to manage.py.

Releasing

First, generate the changelog: create a new feature branch, run just release (it will make a commit), and merge it. Don't delete the branch just yet.

After Github shows a green checkmark against the release commit, tag it with the new version (i.e. git tag v1.2.3) and push the tag.

If the checkmark was not green, you will see an error message. In this case, wait and try again. If the push was successful, you will soon see the new release on Github and Dockerhub.

Deploying

After the image is update on Dockerhub, it is possible to deploy it on the server:

ssh your-username@ip-of-the-server # ask the admin for access
cd ~/docker
vim docker-compose.yml # update the image tag, if it was a major release
docker compose pull rfid-tracker # download the new image
docker compose up -d rfid-tracker # restart with the new image
docker compose logs -f rfid-tracker # confirm that the server didn't die

Pitfalls

Pre-commit

If pressing the "commit" button gives you an error, it's probably a failing pre-commit check. Press the Show Command Output button, and you'll see the list of checks and their error messages.

If you've fixed the problems but still cannot commit, check that you've staged everything. Some pre-commit hooks run code formatters, and you need to manually stage their output.

Direnv

direnv extension fails silently. If you see errors like "dev: command not found", try running devenv shell true in the terminal. It should finish with no errors. If it didn't, then Dmytro broke Nix again.

Terminal will not pick up the new environment until you restart it. You should see a warning sign if direnv wants you to do it.