https://github.com/meereak/backend-smakchet
https://github.com/meereak/backend-smakchet
Last synced: over 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/meereak/backend-smakchet
- Owner: MeeReak
- Created: 2024-04-18T07:57:34.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-22T15:19:40.000Z (about 2 years ago)
- Last Synced: 2025-01-22T05:41:19.854Z (over 1 year ago)
- Language: TypeScript
- Size: 646 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Smakchet
## Table of Contents
- [About The Project](#about-the-project)
- [Built With](#built-with)
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Usage](#usage)
- [Contact](#contact)
## About The Project
In a world where community engagement and social responsibility are more important than ever,
Smakchet aims to connect volunteers with event hosts efficiently. The platform provides two types of
users: normal users who can view and apply for events, and hosts who can post events and manage applications.
This project is designed to simplify the process of finding and managing volunteer opportunities,
making it easier for everyone to contribute to their communities.
Our platform leverages advanced technologies to create a seamless and intuitive experience
for both volunteers and hosts. With user-friendly interfaces, robust search functionalities,
and secure communication tools, we make it easy for volunteers to find events that match their interests and for hosts to find the help they need.
Join us in creating a more engaged and connected community, one volunteer opportunity at a time.
## Built With
This section lists major frameworks and libraries used in the Volunteering Platform project:
- **Figma** (for UX/UI design)
- **Node.js**
- **Next.js**
- **Storybook**
- **Tailwind CSS**
- **TypeScript**
- **Express.js**
- **Jest**
- **MongoDB**
- **Docker**
## Getting Started
### With Docker
Follow these steps to set up this project locally using Docker.
#### Prerequisites
Ensure you have the following software installed before proceeding:
[Docker Desktop](https://www.docker.com/products/docker-desktop/)
#### setup steps
1. Navigate to the volumes folder:
```bash
cd volumes
```
2. Build and run the Docker containers:
```bash
npm run start
```
After completing these steps, your project will be successfully set up locally!
## Usage
Our platform supports two types of users, each with distinct features and functionalities:
### Normal User
- **Explore**: Browse through events and get familiar with the platform.
- **Search**: Find events without registering.
### Volunteer
- **Browse Events**: Use the search feature to find events based on your interests and availability.
- **Apply for Events**: Submit applications for events you're interested in.
### Event Host
- **Create Events**: Post new events and provide details such as time, location, and requirements.
- **Manage Applications**: View applications, and accept or reject candidates.
- **Communicate**: Use the platform’s messaging system to interact with volunteers.
- **Track Attendance**: Monitor which volunteers have been accepted and their attendance status.
## Contact
Rin tithyareak - [Facebook](https://web.facebook.com/mee.reak.9461)
Peng maleap - [Facebook](https://web.facebook.com/izeerry)
figma-Link(https://www.figma.com/design/FRi5rN0B2IiiIOSwgiPLW0/SmakChet?t=UgDDxAnRQFHbTo4Q-0)
Team Email( smakchet.team@gmail.com)