mirror of
https://github.com/nicotsx/zerobyte.git
synced 2026-04-18 13:57:52 -04:00
68 lines
1.6 KiB
Markdown
68 lines
1.6 KiB
Markdown
# AGENTS.md
|
|
|
|
## Important instructions
|
|
|
|
- Never create migration files manually. Always use the provided command to generate migrations
|
|
- If you realize an automated migration is incorrect, make sure to remove all the associated entries from the `_journal.json` and the newly created files located in `app/drizzle/` before re-generating the migration
|
|
- The dev server is running at http://localhost:3000. Username is `admin` and password is `password`
|
|
|
|
## Project Overview
|
|
|
|
Zerobyte is a backup automation tool built on top of Restic that provides a web interface for scheduling, managing, and monitoring encrypted backups. It supports multiple volume backends (NFS, SMB, WebDAV, SFTP, local directories) and repository backends (S3, Azure, GCS, local, and rclone-based storage).
|
|
|
|
### Type Checking
|
|
|
|
```bash
|
|
# Run type checking and generate React Router types
|
|
bun run tsc
|
|
```
|
|
|
|
### Testing
|
|
|
|
```bash
|
|
# Run all tests
|
|
bun run test
|
|
|
|
# Run a specific test file
|
|
bunx dotenv-cli -e .env.test -- bun test --preload ./app/test/setup.ts path/to/test.ts
|
|
```
|
|
|
|
### Building
|
|
|
|
```bash
|
|
# Build for production
|
|
bun run build
|
|
```
|
|
|
|
### Database Migrations
|
|
|
|
```bash
|
|
# Generate new migration from schema changes
|
|
bun gen:migrations
|
|
|
|
# Generate a custom empty migration
|
|
bunx drizzle-kit generate --custom --name=fix-timestamps-to-ms
|
|
|
|
```
|
|
|
|
### API Client Generation
|
|
|
|
```bash
|
|
bun run gen:api-client
|
|
```
|
|
|
|
### Code Quality
|
|
|
|
```bash
|
|
# Format
|
|
bunx oxfmt format --write <path>
|
|
|
|
# Lint
|
|
bun run lint
|
|
```
|
|
|
|
### Invalidation
|
|
|
|
The frontend has an automatic invalidation setup which runs after every mutation.
|
|
Do not implement any invalidation logic in the frontend.
|