Skip to content

jeryjs/Jain-Events-Portal

Repository files navigation

Jain FET Hub

https://jain-fet-hub.vercel.app/

A React app with UI in MUI and Express.js backend for managing events at Jain University, designed to handle thousands of visitors and provide features for event registration, scheduling, and notifications.

Features

  • React Frontend: Built using React and MUI for a modern and responsive UI.
  • Express Backend: Handles API requests and serves the React app.
  • Event Management: Create, update, and manage events.
  • Scalability: Designed to handle thousands of visitors.
  • Customisable: Options for ... etc.

Preview

Build

Prerequisites

  • Node.js
  • Pnpm
    • Note: Pnpm is the recommended package manager for this project, however you can also use npm or any other package manager with its suitable commands.

Clone the Repository

git clone https://github.com/jeryjs/Jain-Events-Portal.git
cd Jain-Events-Portal

Install Dependencies

pnpm run init

Environment Variables Setup

Required Variables

PORT=
JWT_SECRET=
FIREBASE_ACCOUNT_KEY_JSON=

Step-by-Step Instructions

1. Port Configuration
PORT=5000
  • Default is 5000
  • Change if port conflicts exist
2. JWT Configuration
JWT_SECRET=your-secret-key
  • Create any secure random string
  • Recommended: Use a password generator
3. Firebase Setup
FIREBASE_ACCOUNT_KEY_JSON={your-firebase-key-json}
  1. Create Firebase project
  2. Go to Project Settings > Service Accounts
  3. Generate New Private Key
  4. Copy entire JSON content
  5. Paste as single line

Note: Store .env in backend folder and never commit to version control.

Usage

Running the Development Server

cd Jain-Events-Portal
pnpm run dev

Navigate to http://localhost:PORT to see the app in action.

Make sure to setup admin/test accounts in the firestore database first.

Hosting

Deploy to Vercel

Deploy with Vercel

Automatic Deployment

  1. Click the "Deploy with Vercel" button above
  2. Connect your GitHub account
  3. Select repository and configure project settings
  4. Vercel will automatically deploy your application

Manual Deployment

  1. Install Vercel CLI:
    pnpm add -g vercel
  2. Login to Vercel:
    vercel login
  3. Deploy the project:
    vercel

The application will be available at https://your-project.vercel.app

License

This project is licensed under the GNU Affero General Public License v3.0 License - see the LICENSE file for details.

About

A React app with UI in MUI and Express.js backend for managing events at FET, Jain University, designed to handle thousands of visitors and provide features for event registration, scheduling, and notifications.

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages