installation.md

Installing voty.ch

Development Setup

In order to get started with testing, developing and contributing to voty.ch, you will need to first check out our repo and install docker.

git clone https://github.com/teachen-ch/voty.git
cd voty

Now you can lift up the docker environment consisting of the two services «app» and «postgres» (see docker-compose-local.yml).

docker-compose up -f docker-compose.local.yml

On the first run you will need to initialize the database with the schema. We will run prisma migrate --experimental for this (see Prisma CLI docs).

docker exec app yarn run init:db

Now you have an empty database schema, but no content in it to play around. We can get some demo-content into the database, by loading the file testdb.yml into the database. This file be automatically loaded before every test run, so let's just run the tests:

docker exec -it app yarn run test

If you (we?) are lucky, all the tests will pass 🎉. We are still struggling a bit with test flakiness and timeouts, so maybe you want to run above command a second time if it fails. Now let's open our fresh local app in our browser:

http://localhost:3000/

You can create a new teacher account (http://localhost:3000/user/signup), but probably you will not have SMTP configured in your .env.local file, so no activation email will not be sent. In this case, however, a file /tmp/voty-verification-url will be written and within it you will find the activation email with a link to activate your user account. From there on you can create a class, invite students and more.

If you are on a mac, you can automatically open the link in the email in your browser (provided you use bash or zsh):

open `grep http /tmp/voty-verification-url`

Alternatively you can also activate the user directly in the database (users.email_verified = date).

docker exec -it postgres psql -U voty -c "update users set email_verified=NOW() where email='[email protected]'";

Build Process

Once you want to modify the software, you need to have a basic understanding of the build process and how to generate the various (typing-) artifacts with prisma, nexus and graphql-codegen.

When you change the schema.prisma, then you will need to rebuild the prisma client and run database migrations (currently we are running in Prisma's automatic migration mode):

yarn run init:db # runs experimental db migration and generates prisma client

When you change the GraphQL Schema, then you will need to update the typings which are used in the frontend code (we can't use "@prisma/client" because of a next.js bug:

yarn run graphql # generates graphql/types.d.ts

Next Steps

👉 Now go have a look at our tech stack

👉 Study our Prisma Schema: schema.prisma

👉 See how the GraphQL Backend is defined

👉 How permissions are handled with GraphQL-Shield in /graphql/permissions.ts

👉 Have a look at the open issues and see if you want to tackle one 🙏