https://github.com/mugisha-pascal/flutter-offline-app-api

API with PostgreSQL and JWT authentication for Flutter offline-capable task management applications, featuring Docker containerization and Drizzle.
https://github.com/mugisha-pascal/flutter-offline-app-api

docker drizzle express

Last synced: about 2 months ago
JSON representation

API with PostgreSQL and JWT authentication for Flutter offline-capable task management applications, featuring Docker containerization and Drizzle.

Host: GitHub
URL: https://github.com/mugisha-pascal/flutter-offline-app-api
Owner: MUGISHA-Pascal
Created: 2025-08-05T21:48:10.000Z (11 months ago)
Default Branch: main
Last Pushed: 2026-04-20T13:20:02.000Z (about 2 months ago)
Last Synced: 2026-04-20T15:32:16.188Z (about 2 months ago)
Topics: docker, drizzle, express
Language: TypeScript
Homepage:
Size: 40 KB
Stars: 0
Watchers: 0
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# Flutter Offline App Backend

A Node.js/TypeScript backend API server designed to support a Flutter offline-capable task management application. This backend provides authentication services and task management functionality with PostgreSQL database integration.

## Features

- **User Authentication**: Sign up, login, and token validation
- **Task Management**: Create, read, delete, and sync tasks
- **Offline Support**: Task synchronization capabilities for offline-first Flutter apps
- **JWT Authentication**: Secure token-based authentication
- **PostgreSQL Database**: Robust data persistence with Drizzle ORM
- **Docker Support**: Containerized deployment with Docker Compose
- **TypeScript**: Full type safety and modern JavaScript features

## Tech Stack

- **Runtime**: Node.js with TypeScript
- **Framework**: Express.js
- **Database**: PostgreSQL
- **ORM**: Drizzle ORM
- **Authentication**: JWT with bcryptjs
- **Containerization**: Docker & Docker Compose
- **Development**: Nodemon for hot reloading

## Prerequisites

- Node.js (v18 or higher)
- Docker and Docker Compose
- PostgreSQL (if running locally without Docker)

## Quick Start

### Using Docker (Recommended)

1. Clone the repository:
```bash
git clone
cd Flutter-Offline-App-Backend
```

2. Start the application with Docker Compose:
```bash
docker-compose up --build
```

3. The API will be available at `http://localhost:8000`

### Local Development

1. Install dependencies:
```bash
npm install
```

2. Set up environment variables (create a `.env` file):
```
DATABASE_URL=postgresql://postgres:postgres@localhost:5433/task_manager
PORT=8000
```

3. Start the PostgreSQL database:
```bash
docker-compose up db
```

4. Run the development server:
```bash
npm run dev
```

## API Endpoints

### Authentication

#### POST `/auth/signup`
Create a new user account.

**Request Body:**
```json
{
"name": "John Doe",
"email": "john@example.com",
"password": "securepassword"
}
```

**Response:**
```json
{
"id": "user_id",
"name": "John Doe",
"email": "john@example.com"
}
```

#### POST `/auth/login`
Authenticate user and receive JWT token.

**Request Body:**
```json
{
"email": "john@example.com",
"password": "securepassword"
}
```

**Response:**
```json
{
"token": "jwt_token_here",
"id": "user_id",
"name": "John Doe",
"email": "john@example.com"
}
```

#### POST `/auth/tokenIsValid`
Validate JWT token.