mirror of
https://github.com/harivansh-afk/betterNAS.git
synced 2026-04-15 07:04:44 +00:00
Update README.md
This commit is contained in:
parent
fc6c0c737f
commit
e8584e4a2d
1 changed files with 1 additions and 47 deletions
48
README.md
48
README.md
|
|
@ -1,52 +1,6 @@
|
||||||
# aiNAS
|
# 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.
|
<img width="723" height="354" alt="image" src="https://github.com/user-attachments/assets/4e64fa91-315b-4a31-b191-d54ed1862ff7" />
|
||||||
|
|
||||||
## 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
|
## Architecture
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue