diff --git a/README.md b/README.md index e44ee33..cab7b33 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,16 @@ # 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) @@ -15,18 +19,29 @@ - [`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 -``` \ No newline at end of file +```