docs: introduce architecture bible and migrate README/claude knowledge
This commit is contained in:
86
README.md
86
README.md
@@ -1,87 +1,5 @@
|
||||
# Reanimator Core
|
||||
|
||||
Reanimator Core is a Go service for hardware inventory ingest and operational reliability workflows.
|
||||
Architecture documentation was moved to the Project Bible:
|
||||
|
||||
## Active Scope
|
||||
|
||||
The project currently includes:
|
||||
|
||||
- Projects registry
|
||||
- Assets registry
|
||||
- Components registry
|
||||
- Hardware ingest
|
||||
- Failure ingest and failure views
|
||||
- Timeline events for assets/components
|
||||
- Web UI for dashboard, assets, components, failures, ingest
|
||||
|
||||
The following legacy modules were removed from `main`:
|
||||
|
||||
- LOT
|
||||
- Customers
|
||||
- Locations
|
||||
- Tickets
|
||||
- Analytics
|
||||
|
||||
## API Endpoints
|
||||
|
||||
### Health
|
||||
|
||||
- `GET /health`
|
||||
|
||||
### Registry
|
||||
|
||||
- `GET /projects`
|
||||
- `POST /projects`
|
||||
- `GET /projects/{id}`
|
||||
- `GET /assets`
|
||||
- `POST /assets`
|
||||
- `GET /registry/assets/{id}`
|
||||
- `DELETE /registry/assets/{id}`
|
||||
- `GET /components`
|
||||
- `POST /components`
|
||||
|
||||
### Ingest
|
||||
|
||||
- `POST /ingest/hardware`
|
||||
|
||||
### Timeline
|
||||
|
||||
- `GET /assets/{id}/timeline`
|
||||
- `GET /components/{id}/timeline`
|
||||
|
||||
### Failures
|
||||
|
||||
- `GET /failures`
|
||||
- `POST /failures`
|
||||
|
||||
## UI Routes
|
||||
|
||||
- `GET /ui`
|
||||
- `GET /ui/assets`
|
||||
- `GET /ui/assets/{id}`
|
||||
- `GET /ui/components`
|
||||
- `GET /ui/components/{id}`
|
||||
- `GET /ui/failures`
|
||||
- `GET /ui/ingest`
|
||||
|
||||
## Local Run
|
||||
|
||||
```bash
|
||||
make run
|
||||
```
|
||||
|
||||
or
|
||||
|
||||
```bash
|
||||
go run ./cmd/reanimator-api
|
||||
```
|
||||
|
||||
## Tests
|
||||
|
||||
```bash
|
||||
go test ./...
|
||||
```
|
||||
|
||||
## Migrations
|
||||
|
||||
Schema migrations are located in `migrations/` and are applied at startup.
|
||||
- `bible/README.md`
|
||||
|
||||
Reference in New Issue
Block a user