{"id":19067111,"url":"https://github.com/exploring-solver/stuneckt_assignment","last_synced_at":"2026-04-07T08:01:59.686Z","repository":{"id":238875492,"uuid":"797051510","full_name":"exploring-solver/Stuneckt_assignment","owner":"exploring-solver","description":"This project's goal is to build API endpoints for a microblogging platform like Twitter / LinkedIn where users can post content and follow each other.","archived":false,"fork":false,"pushed_at":"2024-06-11T16:24:37.000Z","size":898,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-07-23T08:58:36.936Z","etag":null,"topics":["express","javascript","mongodb","nextjs","nodejs","typescript"],"latest_commit_sha":null,"homepage":"https://stuneckt-assignment.onrender.com","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/exploring-solver.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","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}},"created_at":"2024-05-07T05:27:26.000Z","updated_at":"2024-06-11T16:24:40.000Z","dependencies_parsed_at":"2024-05-08T17:06:51.056Z","dependency_job_id":"b6fdff24-095b-41f5-8c12-80ddc0a9a5c6","html_url":"https://github.com/exploring-solver/Stuneckt_assignment","commit_stats":null,"previous_names":["exploring-solver/stuneckt_assignment"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/exploring-solver/Stuneckt_assignment","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/exploring-solver%2FStuneckt_assignment","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/exploring-solver%2FStuneckt_assignment/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/exploring-solver%2FStuneckt_assignment/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/exploring-solver%2FStuneckt_assignment/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/exploring-solver","download_url":"https://codeload.github.com/exploring-solver/Stuneckt_assignment/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/exploring-solver%2FStuneckt_assignment/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31504897,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-07T03:10:19.677Z","status":"ssl_error","status_checked_at":"2026-04-07T03:10:13.982Z","response_time":105,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["express","javascript","mongodb","nextjs","nodejs","typescript"],"created_at":"2024-11-09T01:00:04.201Z","updated_at":"2026-04-07T08:01:59.659Z","avatar_url":"https://github.com/exploring-solver.png","language":"JavaScript","readme":"\n# Stuneckt - Microblogging Platform API\n\n## Project Overview\n\nThis project aims to build API endpoints for a microblogging platform similar to Twitter or LinkedIn. Users can post content and follow each other. The backend is implemented in [Node.js](https://nodejs.org/) using [Express.js](https://expressjs.com/) framework, and data is stored in a [MongoDB](https://www.mongodb.com/) database and NextJs and TypeScript is used for Frontend.\n\n## Features\n\n- **User Management**: CRUD operations for user profiles.\n- **Post Management**: CRUD operations for user posts.\n- **Followers**: Ability to follow/unfollow users.\n- **Pagination**: Paginated endpoints for posts and followers.\n- **Error Handling**: Robust error handling for API endpoints.\n- **Mock Data Feeder Script**: A script to feed mock data into the database.\n\n## Setup Instructions\n\n1. Clone the repository: `git clone https://github.com/exploring-solver/Stuneckt_assignment.git`\n2. Install dependencies for client: `cd client` `npm install`\n2. Install dependencies for server: `cd client` `npm install`\n3. Set up environment variables: Create a `.env` file in the root directory as per the format of  `.env.example` file\n4. Start the server: `npm run dev`\n4. Start the client: `npm run dev`\n5. The server should now be running on `http://localhost:5000`.\n5. The client should now be running on `http://localhost:3000`.\n\n## API Endpoints\n\n- `GET /api/users`: Get all users.\n- `GET /users/api/v1/user/details`: Get logged in user's details.\n- `GET /users/:username`: Get a user's details deom username.\n- `POST /users/api/v1/signup`: Create a new user.\n- `POST /users/api/v1/login`: Login a user.\n- `POST /users/create-mock-users`: Create mock users.\n- `PUT /api/users/`: Update a user.\n\n- `GET /posts/api/v1/posts`: Get all posts.\n- `GET /posts/api/v1/posts/user`: Get logged in user's Posts.\n- `GET /posts/api/v1/posts/user/:username`: Get a perticular user's Posts.\n- `POST /posts/api/v1/posts`: Create a new post.\n- `PUT /api/posts/:id`: Update a post.\n- `GET /posts/api/v1/posts?page=M\u0026limit=N`: Get Paginated posts from M to N.\n\n- `GET /follow/followcount/:username`: Get all followers count of a user.\n- `GET /follow/follower/:username`: Get all followers of a user.\n- `GET /follow/following/:username`: Get all following  of a user.\n- `POST /follow/follow/:username`: Follow a user.\n- `DELETE /follow/unfollow/:username`: Unfollow a user.\n\n## Mock Data Feeder Script\n\nTo use the mock data feeder script, go to following route:\n\nAuthorization Required\nPOST: /users/create-mock-users\n\n\nThis will populate the database with mock users and posts for testing purposes.\n\n## Minimal Frontend to Showcase the API\n\n![Screenshot 2024-05-12 235532](https://github.com/exploring-solver/Stuneckt_assignment/assets/123443485/c1d7c9b0-2677-49cb-9056-ebc12baa1dcc)\n![image](https://github.com/exploring-solver/Stuneckt_assignment/assets/123443485/7bcd9659-043a-42e5-a8ce-273eb83df0fa)\n\n\n## Technologies Used\n\n- Next.js\n- TypeScript\n- Node.js\n- Express.js\n- MongoDB\n- JavaScript\n\n## Deployment\n\nThe backend is deployed on [Vercel](https://stuneckt-assignment-c16d.vercel.app/) and can be accessed at [API Base URL (Render)](https://stuneckt-assignment.onrender.com).\n\n## Contributors\n\n- Aman Sharma (@exploring-solver)\n\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fexploring-solver%2Fstuneckt_assignment","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fexploring-solver%2Fstuneckt_assignment","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fexploring-solver%2Fstuneckt_assignment/lists"}