.vscode | ||
public | ||
src | ||
.gitignore | ||
astro.config.mjs | ||
bun.lock | ||
nixpacks.toml | ||
package.json | ||
README.md | ||
tailwind.config.mjs | ||
tsconfig.json |
IEEE @ UCSD Website
Deployment
This site is automatically deployed to netlify. Pushing to the main
branch will trigger a rebuild and deploy.
Contributing
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
- Install bun if you haven't already
- Clone the repository
- Run
bun install
to install dependencies
Testing
To build the site, run bun run build
.
To view the site on your local network, run bun run dev
. View the site at localhost:4321.
The site will automatically rebuild on changes as long as the development server is running.
ENV Variables
Create a .env
file in the root directory of the project. This file should contain the following variables:
- CALENDAR_API_KEY
- PUBLIC_DISCORD_WEBHOOK_LINK
- PUBLIC_SLACK_WEBHOOK_LINK
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