- TypeScript 98.5%
- SCSS 0.8%
- JavaScript 0.5%
- CSS 0.1%
ac156d8f7f* chore: release 0.1.1 * chore: exclude Markdown from formatting checks --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Cayden Tisdale <caydentisdale43@gmail.com> |
||
|---|---|---|
| .github | ||
| documentation | ||
| next | ||
| postman | ||
| scripts | ||
| .dockerignore | ||
| .gitattributes | ||
| .gitignore | ||
| .nvmrc | ||
| .prettierignore | ||
| .prettierrc.json | ||
| .release-please-manifest.json | ||
| CHANGELOG.md | ||
| CODE_OF_CONDUCT.md | ||
| commitlint.config.mjs | ||
| CONTRIBUTING.md | ||
| docker-compose.dev.yml.template | ||
| LICENSE | ||
| package.json | ||
| pnpm-lock.yaml | ||
| pnpm-workspace.yaml | ||
| README.md | ||
| release-please-config.json | ||
Society of Software Engineers Website: the SSEquel
This repo contains the source code for the Society of Software Engineers' website. Built using Next.js, the website is a hub for information about the SSE and provides tools to manage its various data needs.
Directory Structure
nextdirectory holds the Next.js application bootstrapped withcreate-next-app.documentationdirectory contains project documentation including wireframes, domain models, ERDs, etc.
Quickstart
From the repository root:
-
Bootstrap local development:
pnpm run setup:devThis command installs app dependencies, starts local Docker services, and runs database setup commands.
-
Start the app:
pnpm run dev -
Open the app at:
http://localhost:3000
Developer Commands (from repo root)
pnpm run dev— start local development serverpnpm run lint— run lint checkspnpm run test— run testspnpm run typecheck— run TypeScript type checkspnpm run build— run production buildpnpm run format:check— check repository formattingpnpm run prisma:generate— generate the Prisma clientpnpm run check— run lint, tests, type checking, Knip, and a production build
Environment Setup
Follow our environment setup guide to get started with the project.
After installing dependencies from the repository root, copy next/.env.example to next/.env and run pnpm run env:check before starting the dev server.
Required VSCode Extensions
- Tailwind CSS IntelliSense: bradlc.vscode-tailwindcss (Tailwind CSS IntelliSense)
- PostCSS Language Support: csstools.postcss (required for Tailwind CSS IntelliSense)
- Prisma: Prisma.prisma (Prisma file syntax highlighting, formatting, completions, and linting)
Recommended VSCode Extensions:
- GitLens: eamodio.gitlens (GOATed extension for git)
Contributing
If you wish to contribute to the project, please follow the guidelines in the CONTRIBUTING.md file. We welcome contributions of all kinds, including bug fixes, new features, and documentation improvements. Additionally, please stop by the mentoring lab at GOL-1670 to ask questions or get help with your contributions. We are happy to help you get started!
License
This project is licensed under the MIT License - see the LICENSE file for details.