mirror/iceshrimp
1
0
Fork 0
mirror of https://iceshrimp.dev/iceshrimp/iceshrimp synced 2024-12-25 20:18:05 +09:00
Code Issues Actions Packages Projects Releases Wiki Activity
c3110afd99
iceshrimp/docs/development.md
Pyrox ca43e046a0 flake: Cleanup devenv on clean, add helper scripts, and run dev server on devenv up 
Also adds a new config example for use with the devenv scripts, as well
as a developer's guide for setting up the Nix environment. This could
also have steps for speific distros, such as what packages to install,
and specific notes.
2023-05-12 09:09:58 -04:00

1.2 KiB
Raw Blame History

🌎 Calckey Developer Docs

Nix Dev Environment

The Calckey repo comes with a Nix-based shell environment to help make development as easy as possible!

Please note, however, that this environment will not work on Windows outside of a WSL2 environment.

Prerequisites

Once the repo is cloned to your computer, follow these next few steps inside the Calckey folder:

  • Run direnv allow. This will build the environment and install all needed tools.
  • Run install-deps, then prepare-config, to install the node dependencies and prepare the needed config files.
  • In a second terminal, run devenv up. This will spawn a Redis server, a Postgres server, and the Calckey server in dev mode.
  • Once you see the Calckey banner printed in your second terminal, run migrate in the first.
  • Once migrations finish, open http://localhost:3000 in your web browser.
  • You should now see the admin user creation screen!

Note: When you want to restart a dev server, all you need to do is run devenv up, no other steps are necessary.