Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/iiitv/club-collabaration-backend
🌠A coherent portal for clubs of our institute.
https://github.com/iiitv/club-collabaration-backend
contribute-a-thon hacktoberfest nodejs web
Last synced: 5 days ago
JSON representation
🌠A coherent portal for clubs of our institute.
- Host: GitHub
- URL: https://github.com/iiitv/club-collabaration-backend
- Owner: iiitv
- Created: 2020-05-22T05:37:18.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-10-24T09:33:47.000Z (20 days ago)
- Last Synced: 2024-10-25T07:09:25.598Z (19 days ago)
- Topics: contribute-a-thon, hacktoberfest, nodejs, web
- Language: JavaScript
- Homepage:
- Size: 35.2 KB
- Stars: 4
- Watchers: 5
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Club Collaboration - Backend
This repository contains the backend API for the Club Collaboration project, which supports the [Club Collaboration frontend](https://github.com/iiitv/club-collaboration-frontend) by providing data and services for clubs, events, announcements, and contact details. The backend is built using Node.js, Express.js, and MongoDB.
## Technology Used
- Node.js
- Express
- MongoDB
## Features
- **Clubs Overview**: Detailed information for all clubs, including members and descriptions.
- **Announcements & Events**: Manage and view club-specific announcements and events.
- **Image Galleries**: Upload and display event or club-related media.
- **Admin Panel**: Manage clubs, announcements, events, and images with admin access.
- **Search & Filter**: Easily find clubs, events, and announcements with search functionality.
- **User Authentication**: Secure login for users and admins.
## Setup Instructions
### Installation
1. Clone the repository:
```bash
git clone https://github.com/iiitv/club-collaboration-backend.git
```
2. Navigate to the project directory:
```bash
cd club-collaboration-backend
```
3. Install dependencies:
```bash
yarn install
```
4. Set up environment variables by creating a `.env` file in the root directory:
```bash
MONGODB_URI=
SESSION_SECRET=
EMAIL=
EMAIL_SECRET=
JWT_SECRET=
```
### Running
```bash
yarn start