Skip to content

PranavReddyy/enigma

Repository files navigation

Enigma Logo

Enigma

Official website for Enigma, the Computer Science Club of Mahindra University

Next.js React Tailwind CSS Framer Motion Supabase Vercel

Enigma Website

Visit the website

Contents

Features

  • Interactive Landing Page: Modern design with smooth animations
  • Events Management: Dynamic events calendar with filtering and search
  • Committee Showcase: Five specialized committees (AI/ML, WebDev, SysCom, GameDev, Cyber)
  • Real-time Updates: Live leaderboards and statistics
  • Responsive Design: Optimized for all devices

How to install

  1. Clone this repository:
git clone https://github.com/PranavReddyy/enigma.git
  1. Go into project directory:
cd enigma
  1. Install dependencies:
npm install
  1. Set up environment variables:

Create a .env.local file in the root directory and add your environment variables:

NEXT_PUBLIC_SUPABASE_URL=your_supabase_url
NEXT_PUBLIC_SUPABASE_ANON_KEY=your_supabase_anon_key
GITHUB_TOKEN=your_github_token
  1. Run the development server:
npm run dev

Open http://localhost:3000 with your browser to see the result.

How to contribute

  1. Fork the repository

  2. Create a new branch for your feature:

git checkout -b feature/your-feature-name
  1. Make your changes and commit them:
git add .
git commit -m "Add your descriptive commit message"
  1. Push to your fork:
git push origin feature/your-feature-name
  1. Submit a pull request to the main branch

Please ensure your code follows the existing style and includes appropriate documentation. Here's a resource on how to write a perfect pull request.

Note: If you wish to add new pages, please add them as new routes under the app directory following Next.js 13+ app router conventions.

Project Structure

enigma/
├── app/                   # Next.js app router pages
├── components/            # Reusable React components
├── lib/                   # Utility functions and configurations
├── public/                # Static assets
└── README.md

Tech Stack

  • Framework: Next.js 14 with App Router
  • Styling: Tailwind CSS with custom components
  • Database: Supabase for events and data management
  • Animations: Framer Motion for smooth interactions
  • Deployment: Vercel for hosting and CI/CD

About

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •