mirror of
https://github.com/willchen96/mike.git
synced 2026-06-24 21:38:06 +02:00
Add local repo contents
This commit is contained in:
parent
65739ef1ce
commit
d9690965b5
176 changed files with 68998 additions and 0 deletions
60
README.md
Normal file
60
README.md
Normal file
|
|
@ -0,0 +1,60 @@
|
|||
# Mike
|
||||
|
||||
Open-source release containing the Mike frontend and backend.
|
||||
|
||||
## Contents
|
||||
|
||||
- `frontend/` - Next.js application
|
||||
- `backend/` - Express API, Supabase access, document processing, and migrations
|
||||
- `backend/migrations/000_one_shot_schema.sql` - one-shot Supabase schema for fresh databases
|
||||
|
||||
## Setup
|
||||
|
||||
Install dependencies:
|
||||
|
||||
```bash
|
||||
npm install --prefix backend
|
||||
npm install --prefix frontend
|
||||
```
|
||||
|
||||
Create local env files from the examples:
|
||||
|
||||
```bash
|
||||
cp backend/.env.example backend/.env
|
||||
cp frontend/.env.local.example frontend/.env.local
|
||||
```
|
||||
|
||||
Run `backend/migrations/000_one_shot_schema.sql` in the Supabase SQL editor for a fresh database.
|
||||
|
||||
Start the backend:
|
||||
|
||||
```bash
|
||||
npm run dev --prefix backend
|
||||
```
|
||||
|
||||
Start the frontend:
|
||||
|
||||
```bash
|
||||
npm run dev --prefix frontend
|
||||
```
|
||||
|
||||
Open `http://localhost:3000`.
|
||||
|
||||
## Required Services
|
||||
|
||||
- Supabase Auth and Postgres
|
||||
- S3-compatible object storage, such as Cloudflare R2
|
||||
- At least one supported model provider key, depending on which models you enable
|
||||
- LibreOffice for DOC/DOCX to PDF conversion
|
||||
|
||||
## Checks
|
||||
|
||||
```bash
|
||||
npm run build --prefix backend
|
||||
npm run build --prefix frontend
|
||||
npm run lint --prefix frontend
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
AGPL-3.0-only. See `LICENSE`.
|
||||
Loading…
Add table
Add a link
Reference in a new issue