https://github.com/alpha951/sporty-connect-deployed
https://github.com/alpha951/sporty-connect-deployed
Last synced: over 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/alpha951/sporty-connect-deployed
- Owner: alpha951
- Created: 2023-11-19T13:07:45.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-11-19T15:51:40.000Z (over 2 years ago)
- Last Synced: 2025-02-01T20:15:50.524Z (over 1 year ago)
- Language: JavaScript
- Homepage: https://sporty-connect-live.vercel.app/
- Size: 5.41 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# SportyConnect Website
A Website to connect sports enthusiasts with each other and with sports facilities.
Deployed at : [sporty-connect-live](https://sporty-connect.vercel.app/)
## Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
```bash
git clone https://github.com/alpha951/sporty-connect-deployed.git
cd sports-connect-website-btp
```
1. Create a .env file same as the .env.example file and fill in the required details.
2. Run the following commands to start the server.
```bash
npm install
npm start
```
## API Endpoints
- [x] [POSTMAN Workspace Link](https://www.postman.com/avionics-astronomer-93868069/workspace/hobby-projects/collection/27853841-fda7f482-bc0c-4839-86d5-258af4fa2e53?action=share&creator=27853841)
### /auth
#### 1. [POST] /auth/register
```bash
example : req.body
{
"name": "player1", #required
"email": "p1@mail.com", #required
"password": "player1@123", #required
"gender": "Male", #required , enum = [Male, Female, Other]
"state": "Rajasthan",
"city": "Jaipur",
"interests": ["Cricket", "Football"],
"age": 21,
"contactNo": "12345",
"skillLevels": "Advanced"
}
response : jwt-token
```
#### 2. [POST] /auth/login
```bash
example : req.body
email:p1@mail.com
password:player1@123
response : jwt-token
```
### /play
#### 1. [GET] /play/getplayers
```bash
req.headers[authorization] = jwt-token
response :
{
{
"data": [
{
"name": "player2",
"city": "Jaipur",
"state": "Rajasthan",
"gender": "Male",
"interests": [
"Cricket",
"Football"
],
"availability": [
{
"dayOfWeek": "Monday",
"timeRanges": {
"startHour": 12,
"endHour": 14,
"_id": "6552150c918315f662553656"
},
"_id": "6552150c918315f662553655"
}
],
"contactNo": "12345",
"skillLevels": "Beginner"
}
]
}
}
```
#### 3. [PATCH]/play/editprofile
```bash
req.headers[authorization] = jwt-token
example : req.body
{
"availability" :
{
"dayOfWeek" : "Monday",
"timeRanges" : {
"startHour" : 12,
"endHour" : 14
}
}
}
response :
{
"data":
{
"_id": "655212804d6e3ca51b335468",
"name": "player2",
"email": "p2@mail.com",
"password": "$2a$10$6q.GaeXaK1CDpWQykF4TOuiJK3eU9JZzpd6QV7gSzYQhN/YYHHWhC",
"gender": "Male",
"state": "Rajasthan",
"city": "Jaipur",
"interests": [
"Cricket",
"Football"
],
"contactNo": "12345",
"skillLevels": "Beginner",
"availability": [
{
"dayOfWeek": "Monday",
"timeRanges": {
"startHour": 12,
"endHour": 14,
"_id": "6552330e0583b50a47cbabb2"
},
"_id": "6552330e0583b50a47cbabb1"
}
],
"createdAt": "2023-11-13T12:11:44.901Z",
"updatedAt": "2023-11-13T14:30:38.188Z",
"__v": 0
}
}
```
### /academy
#### 1. [POST]/academy/add-academy
```bash
req.headers[authorization] = jwt-token
example : req.body
{
"name": "academy1", #required
"sports": ["Cricket", "Football"], #required
"city" : "Jaipur", #required
"state" : "Rajasthan", #required
"address": "Area 51",
}
response :
{
"data": {
"name": "academy1",
"sports": [
"Cricket",
"Football"
],
"state": "Rajasthan",
"city": "Jaipur",
"address": "Area 51",
"createdBy": "6550c3428caab57739826338",
"_id": "6550fdedde22f6f2fe679e8b",
"createdAt": "2023-11-12T16:31:41.969Z",
"updatedAt": "2023-11-12T16:31:41.969Z",
"__v": 0
}
}
```
#### 2. [POST]/academy/get-academy
```bash
req.headers[authorization] = jwt-token
example : req.body
{
"city" : "Jaipur", #required
"state" : "Rajasthan", #required
"sports" : ["Cricket", "Football"], #required
}
response:
{
"data": [
{
"_id": "6550fdedde22f6f2fe679e8b",
"name": "academy1",
"sports": [
"Cricket",
"Football",
"Badminton"
],
"state": "Rajasthan",
"city": "Jaipur",
"address": "Area 51",
"createdBy": "6550c3428caab57739826338",
"createdAt": "2023-11-12T16:31:41.969Z",
"updatedAt": "2023-11-12T16:31:41.969Z",
"__v": 0
}
]
}
```
#### 3. [PATCH]/academy/update-academy/:id
```bash
req.headers[authorization] = jwt-token
example : req.body
{
"name": "academy-new", #optional
"sports": ["Cricket", "Football", "Tennis"], #optional
"city" : "Jaipur", #optional
"state" : "Rajasthan", #optional
"address": "Area 51", #optional
}
response:
{
"data": {
"_id": "6550fdedde22f6f2fe679e8b",
"name": "academy-new",
"sports": [
"Cricket",
"Football",
"Tennis"
],
"state": "Rajasthan",
"city": "Jaipur",
"address": "Area 51",
"createdBy": "6550c3428caab57739826338",
"createdAt": "2023-11-12T16:31:41.969Z",
"updatedAt": "2023-11-12T16:40:14.091Z",
"__v": 0
}
}
```
## Models
We have the following models in the database:
[x] User
[x] Academy
```sql
user {
id string [pk]
name string
email string
password string
age number
gender string
state string
city string
contactNo string
interests string[]
skillLevel string
availability availability
}
timeRange {
id string [pk]
startHour number
endHour number
}
availability {
id string [pk]
dayOfWeek string
timeRange timeRange
}
academy {
id string pk
name string
sports string[]
state string
city string
address string
createdBy string fk
}
academy.createdBy < user.id
```
### DB Diagram
[View on Eraser](https://app.eraser.io/workspace/6MJrIkUNion5y0PEcsXL?elements=NoaseuTABsq7I4a6-P4ygw)