{"id":29024646,"url":"https://github.com/sayedsheikh/flatify-server","last_synced_at":"2025-06-26T04:18:33.056Z","repository":{"id":301155571,"uuid":"1008319097","full_name":"SayedSheikh/flatify-server","owner":"SayedSheikh","description":null,"archived":false,"fork":false,"pushed_at":"2025-06-25T11:48:12.000Z","size":16,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-06-25T12:39:38.835Z","etag":null,"topics":["authentication","cors","dotenv","express","mongodb","nodejs"],"latest_commit_sha":null,"homepage":"","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/SayedSheikh.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,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-06-25T11:08:36.000Z","updated_at":"2025-06-25T12:03:16.000Z","dependencies_parsed_at":"2025-06-25T12:43:03.958Z","dependency_job_id":"fe39bc58-a4ea-4c3a-9736-7811e7f0b15f","html_url":"https://github.com/SayedSheikh/flatify-server","commit_stats":null,"previous_names":["sayedsheikh/flatify-server"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/SayedSheikh/flatify-server","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SayedSheikh%2Fflatify-server","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SayedSheikh%2Fflatify-server/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SayedSheikh%2Fflatify-server/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SayedSheikh%2Fflatify-server/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SayedSheikh","download_url":"https://codeload.github.com/SayedSheikh/flatify-server/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SayedSheikh%2Fflatify-server/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261997993,"owners_count":23242312,"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":["authentication","cors","dotenv","express","mongodb","nodejs"],"created_at":"2025-06-26T04:18:32.375Z","updated_at":"2025-06-26T04:18:33.050Z","avatar_url":"https://github.com/SayedSheikh.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 🔧 Flatify Server\n\nThis is the backend server for **Flatify**, a roommate/flat listing and management web application.  \nIt is built using **Express.js** and **MongoDB**, and deployed on **Vercel**.\n\n---\n\n## 🌐 Live API\n\n✅ Base URL:  \n[https://flatify-server.vercel.app](https://flatify-server.vercel.app)\n\n✅ Example endpoints:\n\n- Get all listings → [`/flatify`](https://flatify-server.vercel.app/flatify)\n- Get featured listings → [`/featured`](https://flatify-server.vercel.app/featured)\n- Get all reviews → [`/reviews`](https://flatify-server.vercel.app/reviews)\n- Get all banners → [`/banner`](https://flatify-server.vercel.app/banner)\n\n---\n\n## 🚀 Features\n\n- ✅ RESTful API for:\n  - All listings: `/flatify`\n  - Single listing by ID: `/flatify/:id`\n  - User-specific listings: `/flatify/mylisting/:email`\n  - Like a listing: `/flatify/like/:id`\n  - Featured listings: `/featured`\n  - Reviews: `/reviews`\n  - Banner content: `/banner`\n- ✅ MongoDB Atlas database integration\n- ✅ CORS enabled for frontend access\n- ✅ Environment variable support via `.env`\n- ✅ JSON request/response format\n\n---\n\n## 📦 Tech Stack\n\n| Layer       | Technology      |\n|-------------|-----------------|\n| **Runtime** | Node.js         |\n| **Server**  | Express.js      |\n| **Database**| MongoDB Atlas   |\n| **Deploy**  | Vercel          |\n\n---\n\n## 🛠️ How to Run Locally\n\nFollow the steps below to run the **Flatify Server** on your local machine:\n\n---\n\n### Step 1: Clone the Repository\n\n```bash\ngit clone https://github.com/your-username/flatify-server.git\ncd flatify-server\n````\n\n\u003e Replace `your-username` with your actual GitHub username.\n\n---\n\n### Step 2: Install Dependencies\n\n```bash\nnpm install\n```\n\n---\n\n### Step 3: Set Up Environment Variables\n\nCreate a `.env` file in the root directory and add the following:\n\n```env\nPORT=5000\nMONGODB_URI=your_mongodb_connection_string\n```\n\n\u003e Make sure your MongoDB URI is from a MongoDB Atlas cluster or a local MongoDB server.\n\n---\n\n### Step 4: Start the Development Server\n\n```bash\nnpm run dev\n```\n\n\u003e This assumes you have a script like `\"dev\": \"nodemon index.js\"` in your `package.json`. If not, use `node index.js`.\n\n---\n\n### Step 5: Test the API\n\nOnce the server is running, go to:\n\n```\nhttp://localhost:5000/flatify\n```\n\nYou should see the JSON data returned from the API 🎉\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsayedsheikh%2Fflatify-server","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsayedsheikh%2Fflatify-server","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsayedsheikh%2Fflatify-server/lists"}