Data Guard: Robust Web Application

Overview

Data Guard, a robust web application, is designed to manage user authentication and CSV data uploads. It ensures data integrity through extensive validation and provides a user-friendly interface for data management.

Key Features

User Authentication:

• Provides Signup, Login, and Logout functionality.
• Employs JWT-based authentication for secure access control.

CSV Data Upload:

• Facilitates CSV file upload and parsing.
• Validates data against predefined schemas before storage.
• Stores validated data into the database.

Database Management:

• Includes migration scripts for database creation and seeding.
• Offers comprehensive scripts for various database operations.

Prerequisites

Ensure the following are installed on your system:

• Node.js (version 14.x or higher)
• PostgreSQL (version 12.x or higher)
• TypeScript

Getting Started

Installation

Clone the repository:

git clone https://github.com/yourusername/backend-data-guard.git
cd backend-data-guard

Install dependencies:

npm install

Set up environment variables: Create a .env file in the root directory and add the following variables:

NODE_ENV=development
PORT=3000
JWT_SECRET=your-secret-key
PGHOST=localhost
PGPORT=5432
PGDATABASE=yourdatabase
PGUSER=yourusername
PGPASSWORD=yourpassword
PGADMINDATABASE=postgres

Database Setup

1. Create the database and tables:

npm run db:create

2. Apply migrations:

npm run db:migrate

3. Seed the database:

npm run db:seed

Running the Application

Start the application in development mode:

npm run dev

The server will be running at http://localhost:3000.

API Endpoints

Authentication

• Signup: POST /auth/signup
• Login: POST /auth/login
• Logout: POST /auth/logout
• Protected Route: GET /auth/protected

Data Upload

• Upload CSV: POST /user/upload

Database Management Commands

-Create the database and tables:

npm run db:create

-Drop the tables:

npm run db:drop

• Apply migrations:

npm run db:migrate

-Revert migrations:

npm run db:migrate:down

• Reset the database:

npm run db:reset

• Seed the database:

npm run db:seed

• Truncate the tables:

npm run db:truncate

• Delete the database:

npm run db:delete

Project Structure

src/
├── api/
│   ├── controllers/
│   │   ├── authController.ts
│   │   └── uploadController.ts
│   ├── middlewares/
│   │   ├── authMiddleware.ts
│   │   └── errorMiddleware.ts
│   ├── routes/
│   │   ├── authRoutes.ts
│   │   └── uploadRoutes.ts
├── config/
│   └── dbConfig.ts
├── data/
│   └── users.data.ts
├── db/
│   ├── migrations/
│   │   ├── 2024.05.13T14.38.26.create-users-db.ts
│   │   └── 2024.05.13T14.38.27.seeds-users-table.ts
│   ├── scripts/
│   │   ├── dbCreate.ts
│   │   ├── dbDrop.ts
│   │   ├── dbMigrate.ts
│   │   └── dbSeed.ts
│   └── utils.ts
├── services/
│   └── auth.service.ts
├── utils/
│   └── validation.ts
├── app.ts
├── index.ts

Contact

For any inquiries or issues, please contact judithhuisa4@mail.com.

Thank you for using Backend Data Guard! Your feedback is highly appreciated.