dcrs

Disability Certificate Register System📇

📄 Usage

To clone and run this application, you'll need Git and Mise installed on your computer.
From your command line:

1. Clone this repository

git clone https://github.com/OpenUp-LabTakizawa/dcrs

2. Install dependencies using Bun

cd dcrs && bun i

3. Set up environment variables

Interactively generate your .env file:

bun setup

Variable	Description	Required
BETTER_AUTH_SECRET	Secret key for Better Auth session encryption	✅
BETTER_AUTH_URL	Base URL for Better Auth (e.g. http://localhost:3000)	✅
AUTH_RESEND_KEY	Resend API key for sending emails	✅
DATABASE_URL	Neon PostgreSQL connection string	✅
DB_TYPE	Database driver type: neon (default) or postgres for standard PostgreSQL	❌
BLOB_READ_WRITE_TOKEN	Vercel Blob read/write token. When set, Vercel Blob is used as the storage backend; otherwise S3 is used	❌
S3_ACCESS_KEY_ID	AWS S3 access key ID (required when using S3 backend)	❌
S3_SECRET_ACCESS_KEY	AWS S3 secret access key (required when using S3 backend)	❌
S3_REGION	S3 region (AWS_REGION is also accepted; required when using S3 backend)	❌
S3_BUCKET	S3 bucket name (uses default value if omitted)	❌
API_URL	Base URL for the API (default: http://localhost:3000)	❌

4. Develop the app

bun dev

5. Test the app

bun test:unit

6. E2E Test

bun test:e2e

7. Format and Lint the files

bun lint:fix

8. Build the app

bun run build

9. Start the app

bun start

🆚 VSCode

Visual Studio Code is the recommended IDE for working on this project, as it has been configured.

Once opening, you can run Extensions: Show Recommended Extensions to install the recommended extensions for good development is automatically configured.

🐳 Dev Containers

A dev container is a running container with a well-defined tool/runtime stack and its prerequisites.
You can try out dev containers with GitHub Codespaces or Visual Studio Code Dev Containers.

Setting up the dev container

GitHub Codespaces

GitHub Codespaces is a cloud-based development environment that allows you to work on this project directly in your browser.
You can click the badge above or here to get started.

Follow these steps to open this project in a Codespace:

1. Click the Code drop-down menu.
2. Click on the Codespaces tab.
3. Click Create codespace on main.

For more info, check out the GitHub documentation.

VSCode Dev Containers

Follow these steps to open this project in a container using the VSCode Dev Containers extension:

1. If this is your first time using a dev container, please ensure your system meets the pre-reqs (i.e. have Docker installed) in the getting started steps.

2. To use this repository, open a locally cloned copy of the code:

   • Clone this repository to your local filesystem.
   • Press F1 and select the Dev Containers: Open Folder in Container... command.
   • Select the cloned copy of this folder, wait for the container to start, and try things out!

🫶 Contribute

Want to report a bug, contribute some code, or improve the documentation? Excellent!
Read up on our guidelines for contributing and Code of Conduct.
Then check out one of our issues labeled as 😵‍💫help wanted or good first issue.

♥️ Contributors

📦 Credits

This software uses the following open source packages:

• AWS Lambda Web Adapter
• Better Auth
• Biome
• Bun
• daisyUI
• Drizzle
• HAPPY DOM
• Mise
• Next.js
• Node.js
• Playwright
• React
• TanStack Form
• StackBlitz Codeflow
• Tailwind CSS
• TypeScript

⚖️ License

The Apache License Version 2.0 (2026) - OpenUp-LabTakizawa. Please have a look at the LICENSE for more details.