building out frontend and docker
This commit is contained in:
22
README.md
22
README.md
@@ -14,10 +14,30 @@ There is also a small web page that shows each project's file tree, sync status,
|
||||
|
||||
## Status
|
||||
|
||||
In development. The sync core and database layer are built and tested against simulated SharePoint and ACC. The real SharePoint/ACC connections and the web UI are next. See:
|
||||
In development. The sync engine, database, scheduler and web UI are built, and you can try them end to end in **simulated mode**. The real SharePoint/ACC connections come next, once credentials arrive. See:
|
||||
|
||||
- [docs/design.md](docs/design.md): architecture, interfaces, data model and build order
|
||||
- [docs/access-setup.md](docs/access-setup.md): what IT and the ACC admin need to set up
|
||||
- [docs/runbook.md](docs/runbook.md): deploying with Docker/Portainer, updating, backups, troubleshooting
|
||||
|
||||
## Running it locally
|
||||
|
||||
```sh
|
||||
npm install
|
||||
cp .env.example .env # simulated mode, admin login admin / change-me
|
||||
npm run dev
|
||||
```
|
||||
|
||||
In simulated mode, SharePoint and ACC are in-memory stand-ins. A demo project is created at startup, filled with sample files, and edited at random every 45 seconds so there's something to watch. One file (`Corrupt model.rvt`) is always rejected, so the issues list has something in it. Nothing persists: a restart starts over.
|
||||
|
||||
| Command | What it does |
|
||||
| --------------- | ------------------------------------------------------------------------------------------------------------------- |
|
||||
| `npm test` | Unit and integration tests (Vitest) |
|
||||
| `npm run check` | Type check |
|
||||
| `npm run lint` | Prettier + ESLint |
|
||||
| `npm run build` | Production build into `build/` (`node build` runs it; run it from the repo root so `drizzle/` migrations are found) |
|
||||
|
||||
To try the Docker image locally: put `ADMIN_USERNAME`, `ADMIN_PASSWORD`, `SESSION_SECRET`, `SYNC_BACKEND=simulated` and `ORIGIN=http://localhost:3000` in `.env`, then run `docker compose up -d --build`.
|
||||
|
||||
## Stack
|
||||
|
||||
|
||||
Reference in New Issue
Block a user