Installation¶

Prerequisites¶

e.g. Node.js 20+, package manager, database
Git

Clone the repo¶

git clone https://github.com/YOUR-ORG/YOUR-REPO.git
cd YOUR-REPO

Repository structure¶

Fill this in as the repo takes shape. A common starting point for this project's "non-monolithic front-end and back-end" requirement:

.
├── client/          # front-end application
├── server/          # back-end / API
├── docs/            # this documentation site (mkdocs)
├── mkdocs.yml
└── README.md

Install dependencies¶

# client
cd client && npm install

# server
cd ../server && npm install

Next steps¶

Continue to Local Development to run the app.