docs: add application goal and project setup instructions to documentation

This commit is contained in:
Peter Wood
2025-05-03 08:18:41 -04:00
parent 06dfbf9965
commit 79e3831004
2 changed files with 90 additions and 3 deletions

View File

@@ -9,14 +9,16 @@ Okay, let's set up a skeleton Fastify API project with Prisma to interact with a
**Project Setup Steps:**
1. **Create Project Directory & Initialize:**
1. **Create Project Directory & Initialize:**
```bash
mkdir finance-api
cd finance-api
npm init -y
```
2. **Install Dependencies:**
2. **Install Dependencies:**
```bash
# Runtime dependencies
npm install fastify @prisma/client dotenv
@@ -408,4 +410,4 @@ Okay, let's set up a skeleton Fastify API project with Prisma to interact with a
curl http://localhost:3050/api/bank-account/YOUR_ACCOUNT_ID
```
This skeleton provides the core structure. You can build upon this by adding more robust error handling, input validation (using Fastify's built-in schema validation), authentication/authorization, more complex queries, and organizing routes into separate files/plugins as the application grows.
This skeleton provides the core structure. You can build upon this by adding more robust error handling, input validation (using Fastify's built-in schema validation), authentication/authorization, more complex queries, and organizing routes into separate files/plugins as the application grows.