Codeguide is an open-source tool for creating and viewing code guides. For onboarding, explaining the context of a code review, and more.
Onboard (or re-board) to a new project or feature
With code guides you can help new team members understand the codebase and get up to speed quickly. Also, it's a great way to re-board yourself to a project or feature area you haven't worked on for a while.
Understand the context of a code review/PR change
It makes it easy for PR authors to explain the reasoning behind their decisions and draw attention to important parts of their changes so reviewers can focus on those first.
Make code presentations
You can use Codeguide for creating code presentations, whether it's for a conference talk or a training session.
This is a Next.js project. To bootstrap a similar one, we recommend using create-t3-stack.
Project is written in TypeScript, using:
- AWS DynamoDB as a database (but the plan is to support other databases in the future)
- NextAuth.js for authentication (only GitHub connection at the moment)
- tRPC for handling API requests
- Tailwind CSS for styling
If you want to self host this project, first you need to set up enviroment variables:
AWS_APP_REGION=''
AWS_APP_ACCESS_KEY=''
AWS_APP_SECRET_KEY=''
DYNAMODB_GUIDES_TABLE=''
DYNAMODB_STEPS_TABLE=''
DYNAMODB_COMMENTS_TABLE=''
NEXTAUTH_SECRET=''
NEXTAUTH_URL=http://localhost:3000
then run the development server:
npm run dev
# or
yarn devDYNAMODB_GUIDES_TABLE- used for storing guide info (repository name, owner, createdBy etc)
- partition key:
id(string) - secundary index:
createdBy(string) partition key,createdAt(number) sort key
DYNAMODB_STEPS_TABLE- saved steps for each guide
- partition key:
guideId(string), sort key:changeId(string).changeId(string, ULID)
DYNAMODB_COMMENTS_TABLE- saved comments for each step
- partition key:
guideId(string), sort key:commentId(string, ULID)
After that, open http://localhost:3000 with your browser to see the result.