From e8584e4a2dc5ffd520d7abff484858aed88f4171 Mon Sep 17 00:00:00 2001 From: Hari <73809867+harivansh-afk@users.noreply.github.com> Date: Tue, 31 Mar 2026 20:37:59 -0400 Subject: [PATCH] Update README.md --- README.md | 48 +----------------------------------------------- 1 file changed, 1 insertion(+), 47 deletions(-) diff --git a/README.md b/README.md index 674d387..d452c2c 100644 --- a/README.md +++ b/README.md @@ -1,52 +1,6 @@ # 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. +image ## Architecture