Skip to content

Commit d70b81e

Browse files
authored
Add project architecture documentation
1 parent 1807044 commit d70b81e

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

docs/architecture.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Project Architecture
2+
3+
This document provides an overview of the project’s architecture.
4+
Each project created from this template should update this file to describe its specific design decisions.
5+
6+
## Folder Structure
7+
8+
- `.github/` — GitHub configuration, issue and PR templates, funding info
9+
- `docs/` — Project documentation, setup guides, usage, FAQ, images
10+
- `setup.sh` — Script to automate initial setup (e.g., install dependencies)
11+
- `.gitignore`, `.prettierrc` — Configuration files for code style and version control
12+
- `CHANGELOG.md`, `CODE_OF_CONDUCT.md`, `CONTRIBUTING.md`, `LICENSE` — Community and legal files
13+
14+
## Recommended Workflow
15+
16+
1. Create a new repo from this template.
17+
2. Run `setup.sh` to initialize your project.
18+
3. Update documentation and configuration files as needed.
19+
4. Follow the contributing guidelines for collaboration.
20+
21+
## Extending the Template
22+
23+
- Add your own source code folders (e.g., `src/`, `app/`)
24+
- Customize documentation in `docs/`
25+
- Add CI/CD workflows in `.github/workflows/`
26+
27+
---
28+
29+
Feel free to expand this file with diagrams or more details as your template evolves!

0 commit comments

Comments
 (0)