Update README.md
This commit is contained in:
parent
117d27cd33
commit
d518fafcab
1 changed files with 21 additions and 3 deletions
24
README.md
24
README.md
|
@ -8,11 +8,17 @@ This site is automatically deployed to netlify. Pushing to the `main` branch wil
|
||||||
|
|
||||||
Please create a new branch for development (i.e. `[NAME]-dev`). Pushing directly to main is not advised, as changes will go straight into production. Once you are ready to merge your changes, create a pull request and request a review from a webmaster.
|
Please create a new branch for development (i.e. `[NAME]-dev`). Pushing directly to main is not advised, as changes will go straight into production. Once you are ready to merge your changes, create a pull request and request a review from a webmaster.
|
||||||
|
|
||||||
|
### Setup
|
||||||
|
|
||||||
|
1. Install [bun](https://bun.sh) if you haven't already
|
||||||
|
2. Clone the repository
|
||||||
|
3. Run `bun install` to install dependencies
|
||||||
|
|
||||||
### Testing
|
### Testing
|
||||||
|
|
||||||
To build the site, run `pnpm build`.
|
To build the site, run `bun run build`.
|
||||||
|
|
||||||
To view the site on your local network, run `pnpm dev`. View the site at [localhost:4321](http://localhost:4321).
|
To view the site on your local network, run `bun run dev`. View the site at [localhost:4321](http://localhost:4321).
|
||||||
|
|
||||||
The site will automatically rebuild on changes as long as the development server is running.
|
The site will automatically rebuild on changes as long as the development server is running.
|
||||||
|
|
||||||
|
@ -24,4 +30,16 @@ Create a `.env` file in the root directory of the project. This file should cont
|
||||||
- PUBLIC_DISCORD_WEBHOOK_LINK
|
- PUBLIC_DISCORD_WEBHOOK_LINK
|
||||||
- PUBLIC_SLACK_WEBHOOK_LINK
|
- PUBLIC_SLACK_WEBHOOK_LINK
|
||||||
|
|
||||||
If you do not include this in the .env file, the site will give you an error.
|
If you do not include these variables in the .env file, the site will give you an error.
|
||||||
|
|
||||||
|
### Project Structure
|
||||||
|
|
||||||
|
```
|
||||||
|
├── src/
|
||||||
|
│ ├── components/ # Reusable components
|
||||||
|
│ ├── data/ # JSON data files
|
||||||
|
│ ├── layouts/ # Page layouts
|
||||||
|
│ └── pages/ # Page components
|
||||||
|
├── public/ # Static assets
|
||||||
|
└── astro.config.mjs # Astro configuration
|
||||||
|
```
|
||||||
|
|
Loading…
Reference in a new issue