README.md

Farm NestJS API

farm-nestjs-api-development-setuo.mov

Technologies

• NodeJS v22
• NestJS v11
• PrismaORM
• Docker
• PostgreSQL

Prerequisites

• Node v22 and NPM v11

nvm install 22.9.0
nvm use 22.9.0
npm install -g npm@11.4.2

Local Development Setup using Docker

1. Clone repository

git clone git@github.com:AlexGalhardo/farm-nestjs-api.git

2. Enter repository

cd farm-nestjs-api/

3. Install dependencies

npm install

4. Setup your environment variables

cp .env.example .env

5. UP Docker with Postgres & API

sudo chmod +x setup.sh && ./setup.sh

6. The Server API will start Inside docker connecting to your local machine at: http://localhost:3000

Prisma Studio (DataBase GUI)

• To Start Prisma Studio:

npm run prisma:studio

Build

a. Creating build

npm run build

b. Testing build server locally

npm run start

API Requests and Docs

• You can see and use the HTTP Requests references inside folder rest-client/
• OpenAPI Documentation (using Swagger)
  • Local: http://localhost:3000/api-docs

Tests

a. Run all unit mocked tests

npm run test

b. Run all end to end tests

npm run test:e2e

License

MIT

Copyright (c) June 2025-present, Alex Galhardo