Skip to content

Commit aa5aacc

Browse files
feature: add documentation to readme
1 parent f27ace1 commit aa5aacc

3 files changed

Lines changed: 37 additions & 1 deletion

File tree

README.rst

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,32 @@ Run ``just`` to see all available commands.
7474
Documentation
7575
=============
7676

77-
Coming soon...
77+
Comprehensive guides for understanding and customizing this template:
78+
79+
Backend
80+
-------
81+
82+
- `Backend Architecture <https://github.com/CarterPerez-dev/fullstack-template/blob/documentation/docs/wiki/backend.md>`_
83+
84+
Complete backend architecture including FastAPI setup, security patterns (JWT + Argon2id), database models, repository pattern, services, API endpoints, testing, and production deployment.
85+
86+
Frontend
87+
--------
88+
89+
- `Frontend Architecture <https://github.com/CarterPerez-dev/fullstack-template/blob/documentation/docs/wiki/frontend.md>`_
90+
91+
React 19 + TypeScript architecture with TanStack Query, Zustand state management, complete design system (OKLCH colors), API integration patterns, SCSS utilities, and performance optimizations.
92+
93+
Infrastructure
94+
--------------
95+
96+
- `Nginx Configuration <https://github.com/CarterPerez-dev/fullstack-template/blob/documentation/docs/wiki/nginx.md>`_
97+
98+
Reverse proxy setup, rate limiting, WebSocket proxying, caching strategies, security headers, and performance tuning for both development and production.
99+
100+
- `Docker & Compose <https://github.com/CarterPerez-dev/fullstack-template/blob/documentation/docs/wiki/docker.md>`_
101+
102+
Multi-stage Dockerfiles, health checks, network segmentation, resource limits, security hardening, and complete containerization guide.
78103

79104
----
80105

frontend/.vite/deps/_metadata.json

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"hash": "f6f0f452",
3+
"configHash": "058b24a9",
4+
"lockfileHash": "f3316924",
5+
"browserHash": "bd189bd3",
6+
"optimized": {},
7+
"chunks": {}
8+
}

frontend/.vite/deps/package.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"type": "module"
3+
}

0 commit comments

Comments
 (0)