FLUX:

Full-Stack Authentication & Content Management System

Overview

This project is a full-stack authentication and content management system built with NestJS (backend) and Next.js (frontend). It supports role-based access control (RBAC) for two types of content:

• Posts: Can be managed by both Users and Admins.
• Blogs: Only Admins can create, update, and delete, while Users can only view.

User Roles & Permissions:

• Admin: Full CRUD access to Posts & Blogs.
• Regular User: Can create, update, and delete their own Posts but only view Blogs.

Features

1. Authentication (Signup & Login)

• Users sign up and log in using email and password.
• Passwords are securely hashed using bcrypt.
• Authentication is managed using JWT (JSON Web Tokens).
• Frontend validation is implemented with Zod.
• Users are redirected to the dashboard based on their role after login.

2. User Roles & Authorization

• Role-Based Access Control (RBAC) is implemented using NestJS Guards.
• Different permissions for Admin and Regular Users.

3. CRUD Operations

Posts (For Both Admins & Users)

• Fields: image, content, date, author
• Admin & Users can:
  • Create new posts
  • Update their own posts
  • Delete their own posts
  • View all posts
• Search & Filter:
  • Users can search posts by content or date.
  • Pagination is implemented for better performance.

Blogs (For Admin Only)

• Fields: image, title, content, created_at
• Admin can:
  • Create, update, delete, and view all blogs.
• Users can:
  • Only view blogs.

4. Styling

• Uses Tailwind CSS for a clean and responsive UI.
• Ensures mobile-friendly design.

Tech Stack

Backend (NestJS)

• NestJS (with TypeScript)
• PostgreSQL (database)
• TypeORM (ORM for database management)
• JWT Authentication (for user sessions)
• Guards (for role-based access control)
• Multer (for image uploads)

Frontend (Next.js)

• Next.js (React framework for SSR & CSR rendering)
• React Hook Form (with Zod for validation)
• React Query (for efficient API requests)
• Tailwind CSS (for styling)

Installation & Setup

Prerequisites

• Node.js (v16+)
• PostgreSQL

1. Clone the repository

git clone https://github.com/fighteros/flux.git
cd flux

2. Backend Setup (NestJS)

create .env file and file values for env variables from file apps/backend/config/configurations.ts

cd backend
npm install

• Create a .env file and configure database credentials:

DB_HOST=host-to-db
DB_PORT=por
DB_USERNAME=you-db-user
DB_PASSWORD=you-db-password
DB_NAME=your-db-name
PORT=port-to-the-backend-server # only in local development
NODE_ENV=development #set to production if deployed
JWT_SECRET=-your-jwt-secert
JWT_EXPIRES_IN='1d'  #3600s
CLOUD_NAME=-get-from-cloudinary
CLOUDINARY_API_KEY=-get-from-cloudinary
CLOUDINARY_API_SECRET=-get-from-cloudinary
ADMIN_EMAIL=set-email-for-the-admin-user-that-you-would-seed
ADMIN_PASSWORD=set-admin-password

• Run migrations and start the backend server:

# seed admin user
npm run seed:admin
# seed posts (optional)
npm run seed:posts
# seed blogs (optional)
npm run seed:posts

3. Frontend Setup (Next.js)

cd frontend
npm install

4. RUN

npm run dev

4. Access the App

• Frontend: http://localhost:3000
• Backend API: http://localhost:8000

Contributing

Feel free to open an issue or submit a pull request.

License

This project is licensed under the MIT License.