Skip to content

EdurekaRPI/back-end

Repository files navigation

🎓 Edureka

GitHub Repository

Project Overview

Edureka is a university-wide dashboard designed to assist President Schmidt’s Event Office at RPI in advertising and creating campus events. The platform provides event planning tools, an integrated event calendar, and collaboration with other event planning applications such as RPI Eventhub and Study Compass. Our goal is to enhance event organization and increase campus engagement.


📋 Core Features

  1. Event Planning Tool

    • Decision tree to determine the level of involvement from the Event Office.
    • Checklist and resource request tools for event planners.
    • Request approval functionality for event planners.
    • Potential chat feature for communication among planners (optional based on timeline).
    • Data analytics and reporting capabilities to optimize operational efficiency.
    • Multiple account tiers for users (students, professors, administrators).
  2. Event Calendar

    • Displays upcoming campus events.
    • Filter events by type.
    • Add events to personal calendars (e.g., Google Calendar).
  3. Third-Party Integration

    • Integrates with existing applications like RPI Eventhub and Study Compass.
    • Allows other applications to access and create events via our system.

🛠 Tech Stack

Frontend

  • React.js
  • Tailwind CSS
  • Axios

Backend

  • Express.js
  • MongoDB

🚀 Getting Started

1. Clone the Repository

To get started with Edureka, you'll first need to clone the repository to your local machine:

git clone https://github.com/EdurekaRPI/Edureka.git
cd Edureka

2. Set Up the Environment

Backend Setup

  1. Install the required dependencies:

    tbd
    
  2. Create a .env file in the backend directory and add the following environment variables:

    tbd
    
  3. Run the backend server:

    tbd
    

    The server should now be running on http://localhost:5000.

Frontend Setup

  1. Navigate to the frontend directory and install dependencies:

    tbd
    
  2. Start the frontend development server:

    tbd
    
    

📝 License

This project is licensed under the MIT License.

MIT License

Copyright (c) 2024 EdurekaRPI

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

For more details, visit our GitHub repository: Edureka GitHub.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •