This repository contains the source code for the CSSU website. It is built using Next.js with the App directory, TailwindCSS, and TypeScript, and is hosted on Netlify.
The website is highly customizable yet easy to maintain and compile statically. It is a re-write of the original Hugo ReFresh theme, which was built using Hugo and SASS and licensed under MIT.
This repository uses Yarn as the primary package manager. You can install it by following the instructions on the official website.
yarn install # Install dependencies
yarn dev # Start the development server
yarn lint # Lint the code
yarn clean # Clean the build files
yarn build # Build the website
yarn start # Start the production serverOpen http://localhost:3000 with your browser to see the result.
Tip
Although the Next.js build is configured to produce a static export, we recommend running the Next.js server. To do so, remove the specified lines in next.config.mjs file, replace all occurances of Image with the import from next/Image, and edit yarn start in the package.json file to run the command next start.
Note
Sharp is installed as a server-side dependency to optimize images. If you encounter issues with the Sharp package, install it using yarn install --ignore-engines. By default, this is included in the build process to ensure the correct version is installed.
The website content is built from the ground up using MDX files located in the content directory. To learn how to customize the website, refer to the GitHub Wiki.
We welcome contributions! Please fork this repository and submit a pull request with your changes. If you have a feature request or have found a bug, please open an issue.
To learn more about the internal workings of the website, including how static pages are generated and MDX files are processed, refer to the GitHub Wiki.
This project is licensed under the AGPL-3.0-only license. See the LICENSE file for details.
This project is a re-write of the original Hugo ReFresh theme, licensed under the MIT License.