Skip to content

Latest commit

 

History

15 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

EventPulse README

Welcome to EventPulse, the ultimate event management platform designed for college clubs to manage events efficiently and effectively. This README file will guide you through the setup, features, and usage of EventPulse.

Table of Contents

  1. Introduction
  2. Installation
  3. Configuration
  4. Contributing

Introduction

EventPulse is a comprehensive event management platform tailored for college clubs. It allows clubs to organize, promote, and manage their events seamlessly. With EventPulse, clubs can streamline their event planning process, improve communication, and increase participation.

Installation

Follow these steps to install EventPulse:

  1. Clone the Repository
    git clone https://github.com/uditpadhan98/eventPulse.git
  2. Navigate to the Directory
    cd eventPulse
  3. Install Dependencies
    npm install
  4. Run the Application
    npm start

Configuration

To configure EventPulse, follow these steps:

  1. Database Configuration: Update the database configuration in backend/index.js with your database credentials.
  2. Environment Variables: Create a .env file in the root directory and add the following environment variables:
    MONGO_URL=your mongoDB uri
    BASE=http://localhost:3000
    

Contributing

We welcome contributions to EventPulse! To contribute, follow these steps:

  1. Fork the repository.
  2. Create a new branch: git checkout -b feature-branch.
  3. Make your changes and commit them: git commit -m 'Add some feature'.
  4. Push to the branch: git push origin feature-branch.
  5. Submit a pull request.

Releases

Packages

Contributors

Languages