{"id":24657744,"url":"https://github.com/mdmassum/3w-assignment","last_synced_at":"2026-04-05T22:37:08.111Z","repository":{"id":272950132,"uuid":"918239520","full_name":"MdMassum/3W-assignment","owner":"MdMassum","description":null,"archived":false,"fork":false,"pushed_at":"2025-01-18T08:16:25.000Z","size":89,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2026-04-05T22:37:04.569Z","etag":null,"topics":["cloudinary","express","jwt","mongodb","multer","nodejs","reactjs"],"latest_commit_sha":null,"homepage":"https://3-w-assignment-zo1b.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/MdMassum.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}},"created_at":"2025-01-17T14:27:57.000Z","updated_at":"2025-01-18T08:16:27.000Z","dependencies_parsed_at":null,"dependency_job_id":"a6030073-7408-4dad-bd02-9e9c53280ec4","html_url":"https://github.com/MdMassum/3W-assignment","commit_stats":null,"previous_names":["mdmassum/3w-assignment"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/MdMassum/3W-assignment","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MdMassum%2F3W-assignment","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MdMassum%2F3W-assignment/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MdMassum%2F3W-assignment/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MdMassum%2F3W-assignment/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MdMassum","download_url":"https://codeload.github.com/MdMassum/3W-assignment/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MdMassum%2F3W-assignment/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31452899,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-05T21:22:52.476Z","status":"ssl_error","status_checked_at":"2026-04-05T21:22:51.943Z","response_time":75,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6: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":["cloudinary","express","jwt","mongodb","multer","nodejs","reactjs"],"created_at":"2025-01-26T00:34:45.445Z","updated_at":"2026-04-05T22:37:07.296Z","avatar_url":"https://github.com/MdMassum.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 3W-Assignment Task Backend\n\nThis is the backend implementation for a system that allows users to submit their name, social media handle, and upload multiple images. The submitted data is stored in a database and can be viewed by administrators via a dashboard. Images are stored in Cloudinary.\n\n---\n\n## Directory Structure\n\n```\nproject/\n├── src/\n│   ├── config/\n│   │   ├── cloudinary.js\n│   │   ├── db.js\n│   ├── controllers/\n│   │   ├── adminController.js\n│   │   ├── userController.js\n│   ├── middleware/\n│   │   ├── auth.js\n│   │   ├── fileUpload.js\n│   ├── models/\n│   │   ├── Admin.js\n│   │   ├── User.js\n│   ├── routes/\n│   │   ├── adminRoutes.js\n│   │   ├── userRoutes.js\n│   ├── utils/\n│   │   ├── jwtToken.js\n│   ├── app.js\n├── .env\n├── package.json\n├── README.md\n```\n\n---\n\n## Features\n\n- **User Submission:**\n  - Users can submit their name, social media handle, and upload multiple images.\n  - Images are optional.\n\n- **Admin Dashboard:**\n  - Fetch and display user submissions, including names, social media handles, and uploaded images.\n\n- **Image Storage:**\n  - Images are stored in [Cloudinary](https://cloudinary.com/).\n\n- **Authentication:**\n  - Basic admin authentication is implemented for secure access to the dashboard.\n\n## Tech Stack\n\n- **Node.js**\n- **Express.js**\n- **MongoDB** (with Mongoose)\n- **Cloudinary** (for image storage)\n- **JSON Web Tokens (JWT)** (for admin authentication)\n- **Multer** (for handling file uploads)\n\n---\n\n## Setup Instructions\n\n### Prerequisites\n\n1. **Node.js** and **npm/yarn** installed.\n2. **MongoDB** instance running locally or in the cloud.\n3. **Cloudinary Account**.\n\n### Installation\n\n1. Clone the repository:\n   ```bash\n   git clone \u003crepository-url\u003e\n   cd \u003crepository-folder\u003e\n   ```\n\n2. Install dependencies:\n   ```bash\n   npm install\n   ```\n\n3. Create a `.env` file in the root directory and add the following environment variables:\n   ```env\n   PORT=5000\n   MONGO_URI=\u003cyour_mongo_database_uri\u003e\n   CLOUDINARY_CLOUD_NAME=\u003cyour_cloudinary_cloud_name\u003e\n   CLOUDINARY_API_KEY=\u003cyour_cloudinary_api_key\u003e\n   CLOUDINARY_API_SECRET=\u003cyour_cloudinary_api_secret\u003e\n   JWT_SECRET=\u003cyour_jwt_secret\u003e\n   ```\n\n4. Start the server:\n   ```bash\n   npm run dev\n   ```\n   The backend will be available at `http://localhost:5000`.\n\n---\n\n## API Endpoints\n\n### User Submission\n\n#### POST `/api/users/submit`\nSubmit user data along with optional image uploads.\n\n- **Request Body:**\n  Form-data with the following fields:\n  - `name` (String, required)\n  - `socialMediaHandle` (String, required)\n  - `images` (File, optional, multiple allowed)\n\n- **Response:**\n  ```json\n  {\n    \"success\": true,\n    \"message\": \"User data submitted successfully.\",\n    \"data\": {\n      \"_id\": \"\u003cuser_id\u003e\",\n      \"name\": \"\u003cname\u003e\",\n      \"socialMediaHandle\": \"\u003csocial_media_handle\u003e\",\n      \"images\": [\"\u003cimage_url1\u003e\", \"\u003cimage_url2\u003e\"]\n    }\n  }\n  ```\n\n### Fetch All Users\n\n#### GET `/api/users`\nFetch all user submissions.\n\n- **Response:**\n  ```json\n  {\n    \"success\": true,\n    \"data\": [\n      {\n        \"_id\": \"\u003cuser_id\u003e\",\n        \"name\": \"\u003cname\u003e\",\n        \"socialMediaHandle\": \"\u003csocial_media_handle\u003e\",\n        \"images\": [\"\u003cimage_url1\u003e\", \"\u003cimage_url2\u003e\"]\n      },\n      ...\n    ]\n  }\n  ```\n\n### Admin Authentication\n\n#### POST `/api/admin/login`\nAuthenticate admin using credentials.\n\n- **Request Body:**\n  ```json\n  {\n    \"username\": \"\u003cadmin_username\u003e\",\n    \"password\": \"\u003cadmin_password\u003e\"\n  }\n  ```\n\n- **Response:**\n  ```json\n  {\n    \"success\": true,\n    \"token\": \"\u003cjwt_token\u003e\"\n  }\n  ```\n\n  #### POST `/api/admin/logout`\nAuthenticate admin using credentials.\n\n- **Response:**\n  ```json\n  {\n    \"success\": true,\n    \"message\": \"Logged Out Successfully\"\n  }\n  ```\n\n---\n\n## Key Files and Their Roles\n\n- **`src/models/User.js`**:\n  Defines the User schema for MongoDB.\n\n- **`src/models/Admin.js`**:\n  Defines the Admin schema for MongoDB.\n\n- **`src/controllers/userController.js`**:\n  Handles user-related requests (e.g., submission, fetching data).\n\n- **`src/controllers/adminController.js`**:\n  Handles admin login and authentication.\n\n- **`src/middleware/fileUpload.js`**:\n  Configures Multer for file uploads.\n\n---\n\n## Running Tests\n\nYou can use tools like **Postman** or **cURL** to test the endpoints.\n\n---\n\n\n## Deployed Links\n\n**Frontend Url** - `https://3-w-assignment-zo1b.vercel.app/`\n\n**Backend Url** -  `https://3-w-assignment-backend-ten.vercel.app/`\n\n---\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmdmassum%2F3w-assignment","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmdmassum%2F3w-assignment","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmdmassum%2F3w-assignment/lists"}