- Figma (if you have access)
This is a Next.js project bootstrapped with create-next-app.
Run the development server:
yarn && yarn devOpen http://localhost:3000 with your browser to see the result.
Storybook has been configured to help facilitate component development for this website. To run storybooks:
yarn storybook- Styled Components for CSS.
- Lottie for dynamic SVG animation, namely the logo at the top of the Hero.
This site's philosophy is to use as little external packages as possible. Custom CSS is given priority over Tailwind, MaterialUI etc. Even with what little packages are used, we still get obscure deprecation warnings and browser complaints. If you'd like to contribute, please heavily consider before installing a new Node package.
-
Make or pick an issue to work on. If you'd like to contribute on a problem or feature you've thought of yourself, first make an issue, and wait until it receives approval from a site adminstrator. Otherwise, you're free to pick up an existing issue.
-
Make a branch. Create a git branch with a descriptive name to work on your specific code.
-
Work on the issue on your branch. Try to modify only files relevant to your issue, and stay away from important folders like
/pagesif possible. Furthermore, try to adhere to the existing site structure. For example, place raster images in the relevant folder or base level inassets/img, and SVGs inpublic/svg. If you're working on a discrete component, a great way to preview your component is to make a storyboard to work in. -
Ensure there are no errors. An easy way to do this is running
yarn buildand ensuring no errors prevent the app from building. -
Make a pull request. This way, site administrators can look at & test your code before merging it to the main branch to be included on the deployed site.
And of course, contact the main site administrator Nathaniel Brown if you have any questions!
Special thanks to:
- Abdullah Hasani for providing technical advice and helping to host the website.
- Dylan Nguyen for providing design advice.