mirror of
https://github.com/harivansh-afk/betterNAS.git
synced 2026-04-15 13:03:43 +00:00
57 lines
1.7 KiB
Markdown
57 lines
1.7 KiB
Markdown
# aiNAS
|
|
|
|
aiNAS is a storage control-plane project that uses vanilla Nextcloud as an upstream backend instead of forking the core server. This repository starts with the foundational pieces we need to build our own product surfaces while keeping file primitives, sync compatibility, and existing client integrations delegated to Nextcloud.
|
|
|
|
## Repository Layout
|
|
|
|
- `docker/`: local development runtime for Nextcloud and aiNAS services
|
|
- `apps/ainas-controlplane/`: thin Nextcloud shell app
|
|
- `exapps/control-plane/`: aiNAS-owned control-plane service
|
|
- `packages/contracts/`: shared API contracts used by aiNAS services and adapters
|
|
- `docs/`: architecture and development notes
|
|
- `scripts/`: repeatable developer workflows
|
|
|
|
## Local Development
|
|
|
|
Requirements:
|
|
- Docker with Compose support
|
|
- Node.js 22+
|
|
- npm 10+
|
|
|
|
Bootstrap the JavaScript workspace:
|
|
|
|
```bash
|
|
npm install
|
|
```
|
|
|
|
Start the local stack:
|
|
|
|
```bash
|
|
./scripts/dev-up
|
|
```
|
|
|
|
Stop the local stack:
|
|
|
|
```bash
|
|
./scripts/dev-down
|
|
```
|
|
|
|
Reset the local stack, including Docker volumes:
|
|
|
|
```bash
|
|
./scripts/dev-down --volumes
|
|
```
|
|
|
|
Once the stack is up:
|
|
- Nextcloud: `http://localhost:8080`
|
|
- aiNAS control plane: `http://localhost:3001`
|
|
|
|
The `dev-up` script waits for Nextcloud to report a healthy installed state, falls back to the documented `occ maintenance:install` flow if auto-install has not completed yet, and then enables the `ainascontrolplane` custom app inside the container.
|
|
|
|
## Architecture
|
|
|
|
The intended boundary is documented in `docs/architecture.md`. The short version is:
|
|
|
|
- Nextcloud remains an upstream storage and client-compatibility backend.
|
|
- The custom Nextcloud app is a shell and adapter layer.
|
|
- aiNAS business logic lives in the control-plane service.
|