generated from nhcarrigan/template
docs: document library project and update nav badge
This commit is contained in:
@@ -758,7 +758,7 @@ export const navigation = [
|
|||||||
{
|
{
|
||||||
label: "Library",
|
label: "Library",
|
||||||
link: "/projects/library",
|
link: "/projects/library",
|
||||||
badge: { text: "unversioned", variant: "success" },
|
badge: { text: "v1.1.1", variant: "tip" },
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
label: "Minori",
|
label: "Minori",
|
||||||
|
|||||||
@@ -2,36 +2,57 @@
|
|||||||
title: Library
|
title: Library
|
||||||
---
|
---
|
||||||
|
|
||||||
Library (hereinafter the "Application") is
|
Library (hereinafter the "Application") is Naomi's personal library tracking application for cataloging and engaging with media collections.
|
||||||
|
|
||||||
## 1. User Documentation
|
## 1. User Documentation
|
||||||
|
|
||||||
:::note
|
The live instance is available at `https://library.nhcarrigan.com`.
|
||||||
This section is coming soon!
|
|
||||||
:::
|
|
||||||
|
|
||||||
This section is for those interacting with a live instance of the Application.
|
The application is presented as Naomi's curated collection of media and includes books, games, music, shows, manga, and art.
|
||||||
|
|
||||||
|
Core user-facing capabilities include:
|
||||||
|
|
||||||
|
1. Browsing library entries by media type.
|
||||||
|
2. Engaging with content through comments and likes.
|
||||||
|
3. Submitting suggestions for new additions.
|
||||||
|
4. Viewing activity and leaderboard-style participation features.
|
||||||
|
|
||||||
## 2. Technical Documentation
|
## 2. Technical Documentation
|
||||||
|
|
||||||
:::note
|
The project is an `Nx` monorepo with a frontend app and a Fastify API.
|
||||||
This section is coming soon!
|
|
||||||
:::
|
|
||||||
|
|
||||||
This section is for those interested in running their own instance of the Application.
|
Runtime and build scripts are managed from the repository root:
|
||||||
|
|
||||||
|
1. `pnpm dev` builds and runs the production-style API process with development environment values.
|
||||||
|
2. `pnpm build` generates Prisma client artifacts and builds all projects.
|
||||||
|
3. `pnpm test` runs configured test targets across the workspace.
|
||||||
|
4. `pnpm lint` runs lint targets across the workspace.
|
||||||
|
|
||||||
|
Architecture notes:
|
||||||
|
|
||||||
|
1. API routes are mounted under `/api` via autoloaded Fastify route modules.
|
||||||
|
2. The API includes dedicated modules for `books`, `games`, `music`, `shows`, `manga`, `art`, `suggestions`, `comments`, `likes`, `leaderboard`, `activity`, and `users`.
|
||||||
|
3. Security middleware and plugins include CSRF protection, rate limiting, CORS, helmet, and auth-related plugins.
|
||||||
|
4. Database access is managed with Prisma.
|
||||||
|
|
||||||
## 3. Legal Documentation
|
## 3. Legal Documentation
|
||||||
|
|
||||||
:::note
|
Project policy files reference global documentation:
|
||||||
This section is coming soon!
|
|
||||||
:::
|
|
||||||
|
|
||||||
This section is for expansions to our legal policies specific to the Application.
|
1. License: `https://docs.nhcarrigan.com/#/license`
|
||||||
|
2. Terms: `https://docs.nhcarrigan.com/#/terms`
|
||||||
|
3. Privacy: `https://docs.nhcarrigan.com/#/privacy`
|
||||||
|
4. Security: `https://docs.nhcarrigan.com/#/security`
|
||||||
|
|
||||||
|
Copyright is held by Naomi Carrigan.
|
||||||
|
|
||||||
## 4. Contributing Documentation
|
## 4. Contributing Documentation
|
||||||
|
|
||||||
:::note
|
Contributions are accepted through pull requests according to the repository's contributing guidelines and code of conduct.
|
||||||
This section is coming soon!
|
|
||||||
:::
|
|
||||||
|
|
||||||
This section is for documentation related to contributing to the Application's codebase.
|
Before opening a pull request:
|
||||||
|
|
||||||
|
1. Install dependencies with `pnpm install`.
|
||||||
|
2. Run `pnpm lint`.
|
||||||
|
3. Run `pnpm test`.
|
||||||
|
4. Run `pnpm build`.
|
||||||
Reference in New Issue
Block a user