🤖 Codemight 📚

Development

After cloning the repository, run the following commands to initialize the repo.

pnpm install		# install project dependencies
pnpm run prepare	# initializes husky, for git hooks

The following is a list of the primary scripts for the project.

pnpm run dev		# start development server
pnpm run build		# build project
pnpm run start		# start server for production
pnpm run lint		# lint codebase with ESLint
pnpm run tscheck	# typecheck codebase with Typescript
pnpm run format		# format codebase with Prettier

API

This project uses the following tech for the API.

• tRPC: End-to-end type-safe client-server communication
• Zod: Declarative data validation with user-defined schemas

An interactive documentation page for the tRPC API can be found at /api/trpc during development only.

tRPC API (formatted with tree.nathanfriend.com):

.
├── ping: healthcheck server
├── users/
│   ├── find: 1 user
│   ├── list: many users
│   ├── create
│   ├── update
│   └── remove
├── classes/
│   ├── find: 1 class
│   ├── list: classes where user has access
│   ├── create
│   ├── update
│   └── remove
├── problems/
│   ├── find: 1 class
│   ├── list: problems from all classes where user has access
│   ├── create
│   ├── update
│   └── remove
└── solutions/
    ├── find: 1 solution
    ├── find_latest: latest solution for problem
    ├── list: authored solutions (? for a problem)
    ├── list_latest: latest solutions from all users for a problem
    └── create

Database

pnpm exec drizzle-kit studio		# start database gui client
pnpm exec drizzle-kit generate		# generate migration files
pnpm exec drizzle-kit migrate		# apply migration files

• See Drizzle Studio: quickly viewing contents of the database.

Database Schema (formatted with Jetbrains DataGrip)

Tooling

This project uses the following tools to enforce consistent coding conventions, formatting, and automated workflows:

Formatting & Linting

• Prettier: Enforces consistent code formatting.
• ESLint: Enforces best practices on coding conventions.
• Typescript: Provides static typing and checks.
• CommitLint: Standardizes commit messages based on Conventional Commits.

Automation

• Github Actions: Automates CI workflows, including formatting & linting.

Contributors

In alphabetical order:

• Adrian Labasan (@lukexodus)
• Ajay Lopez (@borzwick)
• Theone Eclarin (@daawaan4x)