Post-it App

A simple social media API built with Node.js, TypeScript, Express, and Prisma. Features include user management, posts, and comments with soft-delete functionality. It was containerized using Docker for consistent development and deployment.

Features

• CRUD operations for Users, Posts, and Comments
• Soft-delete support with onlyDeleted and includeDeleted query params
• Swagger API documentation at /api-docs

Setup

This project uses Docker containers for both the application and PostgreSQL database. Follow these steps to get started locally:

1. Clone the repo: git clone https://github.com/copstud3/post-it-app.git
2. Install dependencies:

   npm install
   

3. Set up environment: Setup .env using .env.example and configure your PostgreSQL database.
4. Run Docker Compose: Starts the app and database in containers.

   docker-compose up --build
   

5. Apply migrations: In a new terminal, run:

   docker-compose exec app npx prisma migrate dev
   

6. Access the app: Visit http://localhost:3000 and Swagger docs at http://localhost:3000/api/v1/docs.

For local development without Docker, use npm run dev after setting up a local PostgreSQL instance.

Branches

• main: Production-ready code (merged from develop via PR).
• develop: Development integration (merged from feature branches via PR).

Database Design

• ERD: View Diagram
• Interactive Diagram: dbdiagram.io Link

API Documentation

Explore the API at http://localhost:3000/api/v1/docs after starting the server.

Workflow

• New features/fixes: Create a feature/<name> branch from develop.
• PR to develop, then develop to main after review.

Version Control

• main: Production branch; merged from develop via PR.
• develop: Development branch; merged from feature branches via PR.
• Feature Branches: Create feature/<name> from develop for new work.
• Commit Messages: Use feat:, fix:, docs:, etc.

Tech Stack

• Node.js
• TypeScript
• Express
• Prisma (PostgreSQL)
• Swagger (OpenAPI)