A rewrite and redesign of chalmersit-rails in Next.js
Suggestions are very welcome, and if you wish to create one, please create an issue using one of the templates. Contributions are also welcome, feel free to create a pull request with your changes.
A few things are required to run the project:
- Node.js v20 for running the web server
- Docker for running other services
- pnpm (installed with
npm install -g pnpm)
In order to run the project in development mode, a few steps are required:
- Install packages with
pnpm install - Start services by running
docker-compose -f docker-compose.dev.yml up -d - Set up the database by running
pnpm prisma generateandpnpm prisma db push - Run
pnpm run devto start the development server
If you wish to modify anything in the database, the recommended way to go is to use Prisma Studio, which can be started by running pnpm prisma studio.
The easiest to run the project in production mode is to use the docker-compose file in the root of the project. This will start all the services needed, and expose the web server on port 3000.
The project can also be compiled into a minimized file structure, which can be run with just Node.
This is done by running pnpm run build, which will build the project to .next/standalone.
Services will however be needed to be started separately.
The project is also compiled this way when building the docker image.
There is a known issue where pino-pretty handles UTF-8 symbols incorrectly on Windows.
For example, checkmarks may display as Ô£ô instead of ✓.
Should these symbols appear, change the current code page to UTF-8 by running chcp 65001 in the terminal that will be used to run the project.
This project uses environment variables to configure its behavior.
The following environment variables are used:
| Variable | Description | Example Value |
|---|---|---|
| DATABASE_URL | Database connection URL | postgresql://postgres:postgres@localhost:5432/postgres?schema=public |
| GAMMA_API_KEY_ID | Gamma info API key ID | api-key-id-uuid-here |
| GAMMA_API_KEY_TOKEN | Gamma info API token | token |
| GAMMA_CLIENT_ID | Gamma OAuth client ID | id |
| GAMMA_CLIENT_SECRET | Gamma OAuth client secret | secret |
| GAMMA_ROOT_URL | Gamma root URL | https://auth.chalmers.it |
| BASE_URL | URL that is used as a base for linking to news | https://chalmers.it |
| NEXTAUTH_SECRET | Secret used for signing cookies | secret |
| NEXTAUTH_URL | URL to the NextAuth API | http://localhost:3000/api/auth |
| MEDIA_PATH | Path to store media | ./media |
| ACTIVE_GROUP_TYPES | Comma-separated list of group types that are considered active | committee,society |
| ADMIN_GROUPS | Comma-separated list of groups that are considered admin groups | styrit |
| CORPORATE_RELATIONS_GROUP | Group that is considered the corporate relations group | armit |