old-ieeeucsd-org/README.md
2022-11-07 08:11:38 -08:00

1.1 KiB

IEEE @ UCSD Website

Deployment

Github Actions have been set to trigger on each push onto the main branch. The website will be built as static pages to the page branch where it will be deployed onto ieeeucsd.org.

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.

Testing

To build the site, run npm run build.

To view the site on your local network, run npm run serve. View the site at localhost:9000.

Images

Large images should be in WebP format. Consider resizing images based on their usage.

Squoosh is a great online tool for optimizing images developed by Google Chrome Labs.

Formatting

Install prettier and use it as the default Typescript and Javascript formatter. The .prettierrc configuration file controls the formatting rules.

For CSS, use CSS Language Features as the default formatter. For HTML, use HTML Language Features as the default formatter.