A React/Next.js project for https://ufssd.org using
Static Site Generation (SSG).
This project aims to help students learn software engineering and web development through rebuilding the UFSSD website. Team members will work through four 2-week sprints where they will use Agile processes, ticket issues, create and review PRs, and utilize other industry practices for software development.
The core framework is React/Next.js and Static Site Generation (SSG).
Additional technologies used are CSS Modules/Tailwind CSS (styling),
ESLint/Prettier (linting), and GitHub Pages (deployment). As the project
progresses this may expand to fulfill other needs like testing and CI/CD.
Prerequisites:
- Install Git and configure for GitHub.
- Install a recent (16.14+) version of Node.js (latest v20 recommended).
- Alternatively, use nvm/nvm-windows if you need to support multiple Node versions.
- (Recommended) Install an IDE of your choice (e.g. Webstorm/VSCode).
- (Recommended) Install React Developer Tools for the browser of your choice (e.g. Chrome).
Project Installation:
- Use
git clone https://github.com/ufssd/ufssd-websiteto clone the project. - Run
npm installto install dependencies. - Run
npm run devto start the development server. - Visit
localhost:3000to view the website.
npm run dev: Starts the development server atlocalhost:3000npm run build: Builds an exported static site to/outnpm run lint: Runs eslint/prettier checking over/srcnpm run lint:fix: Fixes any auto-fixable lint errors