Skip to content

Latest commit

 

History

History
106 lines (74 loc) · 2.88 KB

README.md

File metadata and controls

106 lines (74 loc) · 2.88 KB
Raw

Project Banner
typescript nextdotjs tailwindcss prisma

Anonymous Reporting App

A secure platform for anonymous incident reporting

📋 Table of Contents

  1. 🤖 Introduction
  2. ⚙️ Tech Stack
  3. 🔋 Features
  4. 🤸 Quick Start
  5. 🕸️ Environment Setup
  6. 🚀 Deployment

🤖 Introduction

This is a state-of-the-art anonymous reporting system built with Next.js 14, designed to provide a secure platform for reporting incidents while maintaining complete anonymity.

⚙️ Tech Stack

  • Next.js 14
  • TypeScript
  • Prisma with Neon Database
  • NextAuth.js for Authentication
  • Tailwind CSS
  • React Hook Form
  • GeminiAI
  • BCrypt for Password Encryption

🤸 Quick Start

Prerequisites

Make sure you have the following installed:

Installation

# Clone the repository
git clone <your-repo-url>
cd anonymous-reporting-system

# Install dependencies
npm install

# Set up the database
npx prisma generate
npx prisma db push

# Start the development server
npm run dev

🕸️ Environment Setup

Create a .env file in the root directory with the following variables:

NEXT_PUBLIC_MAPBOX_API_KEY=your-mapbox-key
DATABASE_URL=postgresql:your-database-url
NEXTAUTH_SECRET="your-secret-key"
NEXTAUTH_URL="http://localhost:3000/api/auth"
GEMINI_API_KEY=your-gemini-api-key
NEXT_PUBLIC_MAPBOX_ACCESS_TOKEN=your-mapbox-access-api-key

🚀 Deployment

The application can be easily deployed on Vercel:

  1. Push your code to a Git repository
  2. Connect your repository to Vercel
  3. Configure the environment variables
  4. Deploy!

🤝 Contributing

Contributions are welcome! Please read our Contributing Guidelines first.

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.