# ECSESS Website

> Made by ECSESS 2024-2025

# Prerequisite knowledge

- `npm` knowledge. We use `bun` for this project. See https://bun.sh for installation guide.
- Svelte & SvelteKit: Follow the tutorial here: https://svelte.dev/tutorial/svelte/welcome-to-svelte

# Tech stack

## Frontend

- SvelteKit (Svelte v5, Kit v2)
  - JavaScript with JSDoc
  - [Svelte Auto Adapter](https://svelte.dev/docs/kit/adapters)
- TailwindCSS (v4.0)

- [`bun`](https://bun.sh) as Node.js package manager (similar to `npm`, `yarn`, `pnpm`, and `deno` v2)

## Content Management System (CMS)

- Sanity CMS

# Development guide

- Clone the repo, install dependencies, and start dev environment:

```bash
git clone https://github.com/mcgill-ecsess/ecsess-site.git
bun i
bun run dev
```

- Branches:
  | name | purpose |
  | - | - |
  |`main` | The development of the site, default branch on ECSESS org.|
  |`master`| Deployment of the site, default branch on EUS org.|
  | development branches | If you're working on an issue, **name your branch accordingly** so that we know what feature it is |

- To create a production version of the website:

```bash
bun run build
bun run preview # to preview the production build
```

# Deployment
- Other than the deployment on EUS server with AWS Caddy, there are alternative ways to deploy the website!
## Docker
- Edit the `.env` file to include the `SANITY_ID` of the CMS
- From the root directory of the project
```sh
# Build the website with `nightly` tag
docker build -t ecsess-website:nightly .
docker run -p 4173:4173 ecsess-website:nightly
```
- The site should now be running on `localhost:4173`