Update clarification on branches
This commit is contained in:
15
README.md
15
README.md
@@ -1,12 +1,16 @@
|
|||||||
# ECSESS Website
|
# ECSESS Website
|
||||||
|
|
||||||
> Made by ECSESS 2024-2025
|
> Made by ECSESS 2024-2025
|
||||||
|
|
||||||
# Prerequisite knowledge
|
# Prerequisite knowledge
|
||||||
|
|
||||||
- `npm` knowledge. We use `bun` for this project. See https://bun.sh for installation guide.
|
- `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
|
- Svelte & SvelteKit: Follow the tutorial here: https://svelte.dev/tutorial/svelte/welcome-to-svelte
|
||||||
|
|
||||||
# Tech stack
|
# Tech stack
|
||||||
|
|
||||||
## Frontend
|
## Frontend
|
||||||
|
|
||||||
- SvelteKit (Svelte v5, Kit v2)
|
- SvelteKit (Svelte v5, Kit v2)
|
||||||
- JavaScript with JSDoc
|
- JavaScript with JSDoc
|
||||||
- [Svelte Auto Adapter](https://svelte.dev/docs/kit/adapters)
|
- [Svelte Auto Adapter](https://svelte.dev/docs/kit/adapters)
|
||||||
@@ -15,17 +19,28 @@
|
|||||||
- [`bun`](https://bun.sh) as Node.js package manager (similar to `npm`, `yarn`, `pnpm`, and `deno` v2)
|
- [`bun`](https://bun.sh) as Node.js package manager (similar to `npm`, `yarn`, `pnpm`, and `deno` v2)
|
||||||
|
|
||||||
## Content Management System (CMS)
|
## Content Management System (CMS)
|
||||||
|
|
||||||
- Sanity CMS
|
- Sanity CMS
|
||||||
|
|
||||||
# Development guide
|
# Development guide
|
||||||
|
|
||||||
- Clone the repo, install dependencies, and start dev environment:
|
- Clone the repo, install dependencies, and start dev environment:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
git clone https://github.com/mcgill-ecsess/ecsess-site.git
|
git clone https://github.com/mcgill-ecsess/ecsess-site.git
|
||||||
bun i
|
bun i
|
||||||
bun run dev
|
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:
|
- To create a production version of the website:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
bun run build
|
bun run build
|
||||||
bun run preview # to preview the production build
|
bun run preview # to preview the production build
|
||||||
|
|||||||
Reference in New Issue
Block a user