PorePranav / CampusUnify

https://campusunify.pranavpore.com
Apache License 2.0
4 stars 10 forks source link
hacktoberfest

CampusUnify

CampusUnify is a platform for university club management and student engagement. It aims to facilitate the organization and participation in various clubs and activities on campus. The application provides features for managing club details, events, and student registrations, along with payment processing integrated through Razorpay.

Table of Contents

Features

Tech Stack

Installation

To get started with CampusUnify, follow these steps:

  1. Clone the repository:

    git clone https://github.com/PorePranav/CampusUnify.git
  2. Navigate to the project directory:

    cd CampusUnify
  3. Install the backend dependencies:

    cd server 
    npm install
  4. Install the frontend dependencies:

    cd ../client
    npm install
  5. Set up environment variables:

    Create proper .env file in the client and config.env in the server directories and add your configuration

  6. Run the backend server:

    cd ../server
    npm start
  7. In a new terminal, run the frontend development server:

    cd ../client
    npm run dev

Usage

After starting the application, you can access the frontend at http://localhost:3000.

Contributing

I welcome contributions to CampusUnify! Please read CONTRIBUTING.md file for details on the process for submitting pull requests.

License

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