https://github.com/gautam123bot/projexpeers
A Platform where teams can connect for various competitions and hackathons
https://github.com/gautam123bot/projexpeers
docker firebase-auth javascript mongodb nodejs nodemailer-transport reactjs tailwind-css vercel
Last synced: about 2 months ago
JSON representation
A Platform where teams can connect for various competitions and hackathons
- Host: GitHub
- URL: https://github.com/gautam123bot/projexpeers
- Owner: Gautam123bot
- License: mit
- Created: 2024-12-28T11:04:53.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2025-02-09T13:48:27.000Z (4 months ago)
- Last Synced: 2025-03-30T14:03:45.206Z (3 months ago)
- Topics: docker, firebase-auth, javascript, mongodb, nodejs, nodemailer-transport, reactjs, tailwind-css, vercel
- Language: JavaScript
- Homepage: https://projex-peers.vercel.app
- Size: 3.03 MB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ProjexPeers
ProjexPeers is a web application designed to connect users with potential team members for projects, hackathons, and collaborations. The platform streamlines the process of finding peers and building teams by offering features like user registration, login via email and Google, forgot password functionality, and efficient team management.
The application is fully responsive and deployed using Docker, ensuring portability and ease of setup on any system. Additionally, the frontend is accessible at [ProjexPeers Frontend](https://projex-peers.vercel.app/), making it simple for users to explore and use the platform.
---
## Features
- **User Registration and Authentication**:
Users can easily register and log in using email credentials or authenticate securely via Google.
- **Forgot Password and Reset Password**:
Securely reset passwords through an OTP-based mechanism.
- **Team Member Search**:
Find and connect with peers based on their skills, interests, and project preferences.
- **Responsive Design**:
Optimized for all screen sizes and devices, ensuring a seamless user experience.
- **Docker Deployment**:
Easily deployable using Docker for a streamlined development and production setup.
---
## Technologies Used
### Frontend:
- ReactJS
- PrimeReact
- CSS
- Firebase (for Google Sign-In)
### Backend:
- Node.js
- Express.js
- MongoDB
### Deployment:
- Docker
---
## Prerequisites
Before getting started, ensure the following are installed:
- **Docker**: While Docker simplifies the deployment process, you can also run the application locally on your system.
- **Node.js**: If running locally, ensure that Node.js and npm are installed.
- **MongoDB**: Set up a MongoDB instance, either locally or using a cloud-based service like MongoDB Atlas.
---
## Getting Started
### Clone the Repository:
```bash
git clone https://github.com/Gautam123bot/ProjexPeers
cd projexpeers
# ProjexPeers
ProjexPeers simplifies the process of building teams and fosters collaboration among individuals with shared goals. Whether you're preparing for a hackathon or seeking project partners, ProjexPeers is the platform to make your vision a reality!
---
## 🚀 Features
- Team creation made easy.
- Collaborate with peers sharing similar goals.
- Perfect for hackathons and project partnerships.
---
## 🛠️ Installation
### Prerequisites
- Node.js (v16+)
- Docker (optional for deployment)
### Frontend and Backend Dependencies
1. Navigate to the `frontend` and `backend` directories and install the required dependencies:
```bash
cd frontend
npm install
cd ../backend
npm install
```
---
## 🚀 Run Locally
### Backend
1. Start the backend server:
```bash
npm start
```
### Frontend
1. Navigate to the frontend directory:
```bash
cd frontend
```
2. Start the frontend server:
```bash
npm start
```
---
## 🐳 Docker Deployment
1. Build and run the Docker containers:
```bash
docker-compose up --build
```
---
## 🌐 Access the Application
- Open [ProjexPeers](https://projex-peers.vercel.app/) in your browser to start using the platform.
---
## 🤝 Contributing
We welcome contributions to ProjexPeers! Feel free to open issues or submit pull requests to improve the project.
---
## 👥 Contact
For questions or feedback, reach out to the team at **[[email protected]](mailto:[email protected])**.
---