Skip to content

A Website for showcasing Students Clubs Information.

Notifications You must be signed in to change notification settings

sthaarekh/sarathi

Repository files navigation

Sarathi – Your Ultimate Club Management System

About Sarathi

Sarathi is a centralized platform that simplifies the process of discovering, exploring, and managing university clubs. Whether you're a student looking for the perfect club, a club manager handling events, or university administration overseeing activities, Sarathi makes everything seamless and efficient.

Key Features:

  • All-in-One Club Platform – Manage all club activities in a single system.
  • Discover & Connect – Explore clubs based on interests, activities, and events.
  • Seamless Club Management – Effortless organization for club managers and university admins.
  • Centralized & User-Friendly – No more scattered club details—everything in one place!

Tech Stack

Sarathi is built using the MERN Stack:

  • MongoDB – NoSQL database for efficient data storage
  • Express.js – Backend framework for smooth API handling
  • React.js – Interactive and responsive frontend
  • Node.js – Scalable and fast server-side execution

Getting Started

Prerequisites

Ensure you have the following installed on your system:

  • Node.js (v16+ recommended)
  • MongoDB (Local or Cloud Database like MongoDB Atlas)
  • Git

Installation & Setup

1️⃣ Clone the Repository:

git clone https://github.com/sthaarekh/sarathi.git
cd sarathi

2️⃣ Set Up Backend:

cd backend
npm install

Create a .env file in the backend folder and add the required environment variables:

PORT=5001
DB_URL=""
NODEMAILER_PASSWORD=""
NODEMAILER_EMAIL=""
JWT_SECRET_KEY=""
ADMIN_USERNAME=""
ADMIN_PASSWORD=""
CLOUDINARY_CLOUD_NAME=""
CLOUDIANRY_API_KEY=
CLOUDINARY_API_SECRET_KEY=""

3️⃣ Set Up Frontend:

cd ../frontend
npm install

4️⃣ Run the Application:

  • Start backend:
cd backend
npm run dev
  • Start frontend:
cd ..
npm start

The application should now be running! 🎉


Developer Team

Name GitHub Profile
Arekh Shrestha @sthaarekh
Shubham Yadav @ishubhcodes
Saimon Neupane @SaimonNeupane
Aashutosh Upadhyaya @ASU-N
Risham Raj @rishamraj-17

Contact

For any inquiries or contributions, feel free to reach out: 📧 Email: arekhshrestha@gmail.com
🔗 GitHub Issues: Report an Issue


Contributing

We welcome contributions! If you’d like to improve Sarathi, follow these steps:

  1. Fork the repository.
  2. Create a new branch (feature/your-feature-name).
  3. Make your changes and commit (git commit -m 'Added new feature').
  4. Push to your branch and create a Pull Request.

License

This project is open-source and available under the MIT License.


If you like this project, don't forget to star the repository!

About

A Website for showcasing Students Clubs Information.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 5

Languages