README.md

Complainger

A complaint manager for universities.

Table of contents

• About
• Instructions to run locally
  • Clone the repository
  • Setup:
• Preview
• Built with
• Roadmap
• License

About

This project focuses on building a portal for managing complaints in university-like places. The goal is to develop a portal where students and faculties in a university can securely report their complaints which can be accessed by an admin so that appropriate action can be taken.

Instructions to run locally

Clone the repository

git clone [email protected]:bhavesh-chaudhari/complaint-manager.git

Setup:

Open the project in a code editor and run the below commands from root directory.

• Starting Client:

cd client #change dir to client

npm i #install npm packages

npm run dev #start next.js server in development mode

• Starting Server

cd server #change dir to server

npm i #install npm packages

npm run dev #start express.js server in development mode

Preview

Built with

• Language - Typescript
• Frontend - Next.js
• API - Express.js + Next.js API routes
• Data Synchronization - React Query
• Styling - TailwindCSS
• ORM - Prisma
• Database - PostgreSQL

Roadmap

Since this is a hobby project, I have limited time to work on it. So I am trying to build this project incrementally. Given below is a rough roadmap I intend to follow.

• Building Core Logic
• Add Charts
• Adding Download as PDF option for reports
• Use the app directory in Next.js
• Progressive Web App Setup
• Add Messaging Feature
• Add Notification system
• Add Google Oauth
• Dark Mode
• Setup Refresh Tokens
• Making api end-to-end type safe

License

Licensed under the MIT LICENSE