planning docs
This commit is contained in:
24
README.md
Normal file
24
README.md
Normal file
@@ -0,0 +1,24 @@
|
||||
# SharePoint → ACC Sync
|
||||
|
||||
Keeps project folders in SharePoint mirrored into Autodesk Construction Cloud (ACC / Autodesk Forma Docs), with a few minutes' delay at most. One server can sync many projects. Each project pairs one SharePoint folder with one ACC folder.
|
||||
|
||||
There is also a small web page that shows each project's file tree, sync status, open issues and the last 7 days of sync history. It has a "Run now" button as well.
|
||||
|
||||
## What it does
|
||||
|
||||
- **One-way sync.** SharePoint is the source of truth. Nothing is ever written back to SharePoint.
|
||||
- **Every file operation carries over.** Creates, edits (as new ACC versions), renames, moves and deletes are all mirrored. Removing something from the project's SharePoint root counts as deleting it.
|
||||
- **Files added to ACC by hand are left alone.** The sync only ever changes ACC items it created.
|
||||
- **Temp and lock files are ignored.** That covers `~$*`, `*.tmp`, `Thumbs.db` and similar.
|
||||
- **Failures are retried 3 times**, then reported as an issue on the status page.
|
||||
|
||||
## Status
|
||||
|
||||
Planning. 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
|
||||
|
||||
## Stack
|
||||
|
||||
SvelteKit (TypeScript) on `adapter-node`, running as a single long-lived Docker container. It stores its state in SQLite on a mounted volume. It talks to Microsoft Graph for SharePoint and to the Autodesk Platform Services (APS) Data Management API for ACC.
|
||||
Reference in New Issue
Block a user