Warwick Student Arts Festival 2024 Website

This is the public website for the Warwick Student Arts Festival, written in Next.js.

NOTE: This website has now been archived. The main and production branches will both push to 2024.wsaf.org.uk on GitHub Pages.

Running the Website

You will need to have installed NodeJS v20 and NPM for this to work. If you haven't already done this, you can install the LTS version here.

Then, clone the website through SSH. You'll need to install Git to do this, and setup a SSH key.

git clone [email protected]:WarwickStudentArtsFestival/WSAF24-Website.git

Setup env

cp .env .env.local
nano .env.local

Install npm modules

npm install

Run the development server:

npm run dev

This will start a live-reloading web server at http://localhost:3000.

Database

This project uses a PostgreSQL database to store event information.

Pull schema from the db

npm run prisma:db:pull

Generate Prisma client

npm run prisma:generate

Code and Commit Style

Git Usage

Please complete any work in your own branch related to the issue you are completing. You can click 'Create Merge Request' on the issue to do this, and then create a branch when asked.

When committing changes, precede your message with a Gitmoji so it's easy to see what you have done. The most common ones you may use are:

• 💬 :speech_balloon: - Add or update text and literals
• ✨ :sparkles: - Introduce new features
• 🐛 :bug: - Fix bugs
• 💄 :lipstick: - Add or update the UI and style files.
• 🚨 :rotating_light: - Fix compiler/linter warnings

After you have completed your work, remove the draft status from your merge and assign Josh to review it!

ESLint

We use eslint to ensure that our code is generally high quality and is formatted consistently. This will automatically be run whenever a merge request is created. This can be run with:

npm run lint

npm run lint:fix

If you are using an editor such as IntelliJ or VSCode, I'd recommend setting your editor to automatically run this whenever you save, and fix any issues.

Deployment

Environments

There are two deployment environments which are automatically deployed to after a commit is merged into the main/production branches:

• main - https://wsaf24-main.containers.uwcs.co.uk/
• production - https://wsaf.org.uk

NPM

A deployment build can be built with

npm run build

This can then be served with:

npm run start

Docker

A Docker container can be built and run with:

npm run build
docker build -t wsaf24-docker .
docker run -p 3000:3000 wsaf24-docker