1. (optional) if you're on Windows, you might want to setup WSL to be able to use all Linux functionality this project utilizes
2. install Git to download this project's modules and participate in version management
3. install nvm to be able to switch the currently active Node.js version on your machine (useful when working on multiple Node.js projects)

1. create a directory named maevsi in a directory of your liking

2. download this repository into that newly created directory:

   cd maevsi
   git clone https://github.com/maevsi/maevsi.git

3. switch into the maevsi subdirectory and setup Node:

   cd maevsi
   nvm install
   nvm use

4. then install all dependencies using pnpm, which should include the src directory automatically:

   corepack enable
   pnpm install

5. finally, start the frontend:

   cd src
   pnpm dev

6. you should now be able to access maevsi under http://localhost:3000/! 🎉

1. if you're on Windows, setup WSL to be able to use all Linux functionality this project utilizes
2. install Git to download this project's modules and participate in version management
3. install nvm to be able to switch the currently active Node.js version on your machine
4. install mkcert for development certificate generation and installation, so that all services are available through https
5. install Docker so that all services run in their containers
6. install dargstack to bootstrap a Docker stack setup

1. create a directory named maevsi in a directory of your liking

2. download the project modules maevsi, maevsi_stack, sqitch and stomper into that newly created directory:

   cd maevsi
   git clone https://github.com/maevsi/maevsi.git
   git clone https://github.com/maevsi/maevsi_stack.git
   git clone https://github.com/maevsi/sqitch.git
   git clone https://github.com/maevsi/stomper.git

   • maevsi contains the frontend and database migrations
   • maevsi_stack is the service configuration
   • sqitch is the database migration service
   • stomper is the service that sends emails

3. switch into the maevsi subdirectory and setup Node:

   cd maevsi
   nvm install
   nvm use

4. then install all dependencies using pnpm, including the src directory:

   corepack enable
   pnpm install

5. configure maevsi's DargStack then:

   cd ../maevsi_stack/src/development
   cp stack.env.template stack.env
   pnpm store path
   $EDITOR stack.env # fill PNPM_STORE_DIR with what's printed by the previous command

6. install a root development certificate on your system and create subcertificates for the application:

   mkcert -install
   ./certificates/mkcert.sh

7. you are now ready to start everything up:

   cd ../../
   dargstack deploy

8. finally, create the Docker development images for maevsi, sqitch and stomper so that their services start successfully:

   dargstack build maevsi
   dargstack build sqitch
   dargstack build stomper

9. you should now be able to access maevsi under https://localhost! 🎉

   If there are issues, you can debug the services as described in the following "Container Management" section.

To see if services are running or not you can use Portainer if you prefer a web view instead of the command line:

sudo docker run --name portainer --restart=always -d -p 9000:9000 -v /var/run/docker.sock:/var/run/docker.sock -v portainer_data:/data portainer/portainer-ce

Access Portainer on http://localhost:9000 then. Create a user, add an environment, start the Docker wizard, choose "Socket", name it e.g. "local" and close the wizard. Under "home", select the newly created environment then. You'll have access to all containers, images, volumes and more via the left sidebar then.