{"id":24896933,"url":"https://github.com/alpha951/sporty-connect-deployed","last_synced_at":"2025-03-27T16:41:32.104Z","repository":{"id":208063492,"uuid":"720740321","full_name":"alpha951/sporty-connect-deployed","owner":"alpha951","description":null,"archived":false,"fork":false,"pushed_at":"2023-11-19T15:51:40.000Z","size":5677,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-01T20:15:50.524Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://sporty-connect-live.vercel.app/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/alpha951.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2023-11-19T13:07:45.000Z","updated_at":"2023-11-19T13:55:29.000Z","dependencies_parsed_at":"2023-11-19T14:39:37.881Z","dependency_job_id":null,"html_url":"https://github.com/alpha951/sporty-connect-deployed","commit_stats":null,"previous_names":["alpha951/sporty-connect-deployed"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alpha951%2Fsporty-connect-deployed","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alpha951%2Fsporty-connect-deployed/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alpha951%2Fsporty-connect-deployed/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alpha951%2Fsporty-connect-deployed/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/alpha951","download_url":"https://codeload.github.com/alpha951/sporty-connect-deployed/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245885823,"owners_count":20688535,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-02-01T20:15:52.833Z","updated_at":"2025-03-27T16:41:32.078Z","avatar_url":"https://github.com/alpha951.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# SportyConnect Website\nA Website to connect sports enthusiasts with each other and with sports facilities.\nDeployed at : [sporty-connect-live](https://sporty-connect.vercel.app/)\n\n## Getting Started\nThese instructions will get you a copy of the project up and running on your local machine for development and testing purposes.\n\n```bash\n    git clone https://github.com/alpha951/sporty-connect-deployed.git\n    cd sports-connect-website-btp\n```\n1. Create a .env file same as the .env.example file and fill in the required details.\n2. Run the following commands to start the server.\n```bash\n    npm install\n    npm start\n```\n\n## API Endpoints\n- [x] [POSTMAN Workspace Link](https://www.postman.com/avionics-astronomer-93868069/workspace/hobby-projects/collection/27853841-fda7f482-bc0c-4839-86d5-258af4fa2e53?action=share\u0026creator=27853841) \n\n### /auth\n\n#### 1.  \u003cb\u003e[POST] /auth/register \u003c/b\u003e\n\n```bash\n    example : req.body \n    {\n        \"name\": \"player1\",  #required\n        \"email\": \"p1@mail.com\", #required\n        \"password\": \"player1@123\", #required\n        \"gender\": \"Male\", #required , enum = [Male, Female, Other]\n        \"state\": \"Rajasthan\",\n        \"city\": \"Jaipur\",\n        \"interests\": [\"Cricket\", \"Football\"],\n        \"age\": 21,\n        \"contactNo\": \"12345\",\n        \"skillLevels\": \"Advanced\"\n    }\n    response : jwt-token\n\n```\n\n\n#### 2. \u003cb\u003e[POST] /auth/login\u003c/b\u003e\n    \n```bash\n    example : req.body \n        email:p1@mail.com\n        password:player1@123\n    response : jwt-token\n```\n\n### /play\n\n#### 1. \u003cb\u003e[GET] /play/getplayers\u003c/b\u003e\n```bash\n    req.headers[authorization] = jwt-token\n\n    response :\n    {\n        {\n            \"data\": [\n                {\n                    \"name\": \"player2\",\n                    \"city\": \"Jaipur\",\n                    \"state\": \"Rajasthan\",\n                    \"gender\": \"Male\",\n                    \"interests\": [\n                        \"Cricket\",\n                        \"Football\"\n                    ],\n                    \"availability\": [\n                        {\n                            \"dayOfWeek\": \"Monday\",\n                            \"timeRanges\": {\n                                \"startHour\": 12,\n                                \"endHour\": 14,\n                                \"_id\": \"6552150c918315f662553656\"\n                            },\n                            \"_id\": \"6552150c918315f662553655\"\n                        }\n                    ],\n                    \"contactNo\": \"12345\",\n                    \"skillLevels\": \"Beginner\"\n                }\n            ]\n        }\n    }\n```\n#### 3.  \u003cb\u003e[PATCH]/play/editprofile\u003c/b\u003e\n```bash\n    req.headers[authorization] = jwt-token\n    example : req.body\n        {\n            \"availability\" : \n            {\n                \"dayOfWeek\" : \"Monday\",\n                \"timeRanges\" : {\n                    \"startHour\" : 12,\n                    \"endHour\" : 14\n                }\n            }\n        }\n    response :\n        {\n            \"data\": \n            {\n                \"_id\": \"655212804d6e3ca51b335468\",\n                \"name\": \"player2\",\n                \"email\": \"p2@mail.com\",\n                \"password\": \"$2a$10$6q.GaeXaK1CDpWQykF4TOuiJK3eU9JZzpd6QV7gSzYQhN/YYHHWhC\",\n                \"gender\": \"Male\",\n                \"state\": \"Rajasthan\",\n                \"city\": \"Jaipur\",\n                \"interests\": [\n                    \"Cricket\",\n                    \"Football\"\n                ],\n                \"contactNo\": \"12345\",\n                \"skillLevels\": \"Beginner\",\n                \"availability\": [\n                    {\n                        \"dayOfWeek\": \"Monday\",\n                        \"timeRanges\": {\n                            \"startHour\": 12,\n                            \"endHour\": 14,\n                            \"_id\": \"6552330e0583b50a47cbabb2\"\n                        },\n                        \"_id\": \"6552330e0583b50a47cbabb1\"\n                    }\n                ],\n                \"createdAt\": \"2023-11-13T12:11:44.901Z\",\n                \"updatedAt\": \"2023-11-13T14:30:38.188Z\",\n                \"__v\": 0\n            }\n        }\n```\n### /academy\n#### 1. \u003cb\u003e[POST]/academy/add-academy\u003c/b\u003e\n```bash\n    req.headers[authorization] = jwt-token\n    example : req.body\n        {\n            \"name\": \"academy1\", #required\n            \"sports\": [\"Cricket\", \"Football\"], #required\n            \"city\" : \"Jaipur\", #required\n            \"state\" : \"Rajasthan\", #required\n            \"address\": \"Area 51\",\n        }\n    response :\n        {\n            \"data\": {\n                \"name\": \"academy1\",\n                \"sports\": [\n                    \"Cricket\",\n                    \"Football\"\n                ],\n                \"state\": \"Rajasthan\",\n                \"city\": \"Jaipur\",\n                \"address\": \"Area 51\",\n                \"createdBy\": \"6550c3428caab57739826338\",\n                \"_id\": \"6550fdedde22f6f2fe679e8b\",\n                \"createdAt\": \"2023-11-12T16:31:41.969Z\",\n                \"updatedAt\": \"2023-11-12T16:31:41.969Z\",\n                \"__v\": 0\n        }\n}\n```\n#### 2. \u003cb\u003e[POST]/academy/get-academy\u003c/b\u003e\n```bash\n    req.headers[authorization] = jwt-token\n    example : req.body\n        {\n            \"city\" : \"Jaipur\", #required\n            \"state\" : \"Rajasthan\", #required\n            \"sports\" : [\"Cricket\", \"Football\"], #required\n        }\n    response:\n        {\n            \"data\": [\n                {\n                    \"_id\": \"6550fdedde22f6f2fe679e8b\",\n                    \"name\": \"academy1\",\n                    \"sports\": [\n                        \"Cricket\",\n                        \"Football\",\n                        \"Badminton\"\n                    ],\n                    \"state\": \"Rajasthan\",\n                    \"city\": \"Jaipur\",\n                    \"address\": \"Area 51\",\n                    \"createdBy\": \"6550c3428caab57739826338\",\n                    \"createdAt\": \"2023-11-12T16:31:41.969Z\",\n                    \"updatedAt\": \"2023-11-12T16:31:41.969Z\",\n                    \"__v\": 0\n                }\n            ]\n        }\n\n```\n#### 3. \u003cb\u003e[PATCH]/academy/update-academy/:id\u003c/b\u003e\n```bash\n    req.headers[authorization] = jwt-token\n    example : req.body\n        {\n            \"name\": \"academy-new\", #optional\n            \"sports\": [\"Cricket\", \"Football\", \"Tennis\"], #optional\n            \"city\" : \"Jaipur\", #optional\n            \"state\" : \"Rajasthan\", #optional\n            \"address\": \"Area 51\", #optional\n        }\n    response:\n        {\n            \"data\": {\n                \"_id\": \"6550fdedde22f6f2fe679e8b\",\n                \"name\": \"academy-new\",\n                \"sports\": [\n                    \"Cricket\",\n                    \"Football\",\n                    \"Tennis\"\n                ],\n                \"state\": \"Rajasthan\",\n                \"city\": \"Jaipur\",\n                \"address\": \"Area 51\",\n                \"createdBy\": \"6550c3428caab57739826338\",\n                \"createdAt\": \"2023-11-12T16:31:41.969Z\",\n                \"updatedAt\": \"2023-11-12T16:40:14.091Z\",\n                \"__v\": 0\n            }\n        }\n```\n\n## Models   \nWe have the following models in the database:\n[x] User\n[x] Academy\n\n```sql\nuser {\n  id string [pk]\n  name string\n  email string\n  password string\n  age number\n  gender string\n  state string\n  city string\n  contactNo string\n  interests string[]\n  skillLevel string\n  availability availability\n}\n\ntimeRange {\n  id string [pk]\n  startHour number\n  endHour number\n}\n\navailability {\n  id string [pk]\n  dayOfWeek string\n  timeRange timeRange\n}\n\n\nacademy {\n  id string pk\n  name string\n  sports string[]\n  state string\n  city string\n  address string\n  createdBy string fk\n}\n\nacademy.createdBy \u003c user.id\n```\n### DB Diagram\n[View on Eraser![](https://app.eraser.io/workspace/6MJrIkUNion5y0PEcsXL/preview?elements=NoaseuTABsq7I4a6-P4ygw\u0026type=embed)](https://app.eraser.io/workspace/6MJrIkUNion5y0PEcsXL?elements=NoaseuTABsq7I4a6-P4ygw)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falpha951%2Fsporty-connect-deployed","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falpha951%2Fsporty-connect-deployed","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falpha951%2Fsporty-connect-deployed/lists"}