generated from nhcarrigan/template
docs: document lucinda project and update nav badge
This commit is contained in:
@@ -608,7 +608,7 @@ export const navigation = [
|
||||
{
|
||||
label: "Lucinda",
|
||||
link: "/projects/lucinda",
|
||||
badge: { text: "unreleased", variant: "danger" },
|
||||
badge: { text: "v0.0.0", variant: "caution" },
|
||||
},
|
||||
{
|
||||
label: "Liora",
|
||||
|
||||
@@ -6,33 +6,56 @@ Lucinda (hereinafter the "Application") is a kanban-style task management site.
|
||||
|
||||
## 1. User Documentation
|
||||
|
||||
:::note
|
||||
This section is coming soon!
|
||||
:::
|
||||
The Application is intended as a full-featured cloud-backed task management platform with a Kanban-style workflow.
|
||||
|
||||
This section is for those interacting with a live instance of the Application.
|
||||
Current public deployment listed by the project repository:
|
||||
|
||||
1. https://lucinda.nhcarrigan.com
|
||||
|
||||
The frontend currently routes users to a landing experience (`/landing`) and serves as the basis for expanded board/task flows.
|
||||
|
||||
## 2. Technical Documentation
|
||||
|
||||
:::note
|
||||
This section is coming soon!
|
||||
:::
|
||||
Lucinda is a pnpm workspace monorepo with separate client and server applications.
|
||||
|
||||
This section is for those interested in running their own instance of the Application.
|
||||
Project structure:
|
||||
|
||||
1. `client`: Angular 19 frontend.
|
||||
2. `server`: Fastify API service.
|
||||
|
||||
Workspace tooling:
|
||||
|
||||
1. Root scripts use Turbo (`turbo run dev|build|lint|test`).
|
||||
2. Server development command: `tsx src/index.ts --watch`.
|
||||
3. Server start command: `op run --env-file=./prod.env -- node prod/index.js`.
|
||||
|
||||
Current repository version values:
|
||||
|
||||
1. Root: `0.0.0`
|
||||
2. Client: `0.0.0`
|
||||
3. Server: `0.0.0`
|
||||
|
||||
Current server implementation exposes a root health endpoint on port `12346` returning `{"message":"Hello, world!"}`.
|
||||
|
||||
## 3. Legal Documentation
|
||||
|
||||
:::note
|
||||
This section is coming soon!
|
||||
:::
|
||||
The Application uses the shared nhcarrigan legal documents:
|
||||
|
||||
This section is for expansions to our legal policies specific to the Application.
|
||||
1. Privacy Policy: https://docs.nhcarrigan.com/#/privacy
|
||||
2. Terms of Service: https://docs.nhcarrigan.com/#/terms
|
||||
3. License: https://docs.nhcarrigan.com/#/license
|
||||
|
||||
Repository references:
|
||||
|
||||
1. `PRIVACY.md`
|
||||
2. `TERMS.md`
|
||||
3. `LICENSE.md`
|
||||
|
||||
## 4. Contributing Documentation
|
||||
|
||||
:::note
|
||||
This section is coming soon!
|
||||
:::
|
||||
Contributing guidance points to the shared docs portal:
|
||||
|
||||
This section is for documentation related to contributing to the Application's codebase.
|
||||
1. https://docs.nhcarrigan.com/#/contributing
|
||||
|
||||
Feature delivery is in progress, and the public project feed currently marks Lucinda as work in progress.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user