{"id":25181773,"url":"https://github.com/mdmassum/upraised-assignment","last_synced_at":"2026-05-06T06:32:15.486Z","repository":{"id":276087474,"uuid":"927855737","full_name":"MdMassum/upraised-assignment","owner":"MdMassum","description":null,"archived":false,"fork":false,"pushed_at":"2025-02-06T08:30:35.000Z","size":44,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-04T06:11:30.426Z","etag":null,"topics":["express","jwt","nodejs","postgresql","prisma","typescript"],"latest_commit_sha":null,"homepage":"https://upraised-assignment-brown.vercel.app/","language":"TypeScript","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-02-05T16:51:38.000Z","updated_at":"2025-02-06T08:35:59.000Z","dependencies_parsed_at":"2025-02-08T12:15:22.510Z","dependency_job_id":null,"html_url":"https://github.com/MdMassum/upraised-assignment","commit_stats":null,"previous_names":["mdmassum/upraised-assignment"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/MdMassum/upraised-assignment","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MdMassum%2Fupraised-assignment","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MdMassum%2Fupraised-assignment/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MdMassum%2Fupraised-assignment/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MdMassum%2Fupraised-assignment/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MdMassum","download_url":"https://codeload.github.com/MdMassum/upraised-assignment/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MdMassum%2Fupraised-assignment/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278699096,"owners_count":26030456,"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","status":"online","status_checked_at":"2025-10-06T02:00:05.630Z","response_time":65,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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","jwt","nodejs","postgresql","prisma","typescript"],"created_at":"2025-02-09T17:20:09.220Z","updated_at":"2025-10-07T00:09:37.203Z","avatar_url":"https://github.com/MdMassum.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Upraised-Assignment Task Backend\n\nThis is the backend implementation showcasing my skills in restfull api using nodejs. The submitted data is stored in a postgresql database and can be viewed by administrators via a dashboard.\n\n---\n\n## Directory Structure\n\n```\nproject/\n├── prisma/\n│   ├── schema.prisma\n├── src/\n│   ├── controllers/\n│   │   ├── authController.ts\n│   │   ├── gadgetController.ts\n│   ├── middleware/\n│   │   ├── auth.ts\n│   ├── routes/\n│   │   ├── authRoute.ts\n│   │   ├── gadgetRoutes.ts\n│   ├── services/\n│   │   ├── gadgetService.ts\n│   ├── types/\n│   │   ├── express.d.ts\n│   ├── utils/\n│   │   ├── auth.ts\n│   │ \n│   ├── prisma.ts\n│   ├── server.ts\n│\n├── .env\n├── package-lock.json\n├── package.json\n├── README.md\n├── tsconfig.json\n```\n\n---\n\n\n## Tech Stack\n\n- **Node.js**\n- **Express.js**\n- **PostgreSQL** (with Prisma)\n- **JSON Web Tokens (JWT)** (for admin authentication)\n- **Cookies** (for storing token)\n\n---\n\n## Setup Instructions\n\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=3000\n   DATABASE_URL=\u003cyour_postgreSql_database_uri\u003e\n   JWT_SECRET=\u003cyour_jwt_secret\u003e\n   ```\n   \n4.  Run Migrations (Prisma):\n   ```bash\n   npx prisma migrate dev\n   ```\n\n5. Start the server:\n   ```bash\n   npm run dev\n   ```\n   The backend will be available at `http://localhost:3000`.\n\n---\n\n## API Endpoints\n\n### ### Fetch All gadgets\n\n#### GET `/api/gadgets`\nFetch all the gadgets with success probability generated randomly to each gadget\n\n\n- **Response:**\n  ```json\n  [\n    {\n    \"id\": \"\u003cuser_id\u003e\",\n    \"name\": \"\u003cname\u003e\",\n    \"status\":\"\u003cstatus\u003e\",\n    \"decommissionedAt\": \"\u003cdate\u003e\",\n    \"missionSuccessProbability\": \"\u003crandomSuccess\u003e\"\n    },\n    ...\n    ]\n  ```\n\n### create gadget\n\n#### POST `/api/gadgets`\nCreate a gadget.\n\n- **Request Body:**\n  ```json\n  {\n\n  }\n  ```\n\n- **Response:**\n  ```json\n    {\n        \"id\": \"\u003cid\u003e\",\n        \"name\": \"\u003cname\u003e\",\n        \"status\": \"\u003cstatus\u003e\",\n        \"decommissionedAt\": null\n    }\n  ```\n### Update gadget\n\n#### PATCH `/api/gadgets/:id`\nCreate a gadget.\n\n- **Request Body:**\n  ```json\n  {\n    \"name\": \"\u003cname\u003e\",\n    \"status\": \"\u003cstatus\u003e\",\n  }\n  ```\n\n- **Response:**\n  ```json\n    {\n        \"id\": \"\u003cid\u003e\",\n        \"name\": \"\u003cname\u003e\",\n        \"status\": \"\u003cstatus\u003e\",\n        \"decommissionedAt\": null\n    }\n  ```\n### Delete gadget (decommosion)\n\n#### DELETE `/api/gadgets/:id`\nCreate a gadget.\n\n- **Request Body:**\n  ```json\n  {\n\n  }\n  ```\n\n- **Response:**\n  ```json\n    {\n        \"id\": \"\u003cid\u003e\",\n        \"name\": \"\u003cname\u003e\",\n        \"status\": \"decommossined\",\n        \"decommissionedAt\": \"\u003cdateTime\u003e\"\n    }\n  ```\n### Self-destruct gadget\n\n#### POST `/api/gadgets/:id/self-destruct`\nCreate a gadget.\n\n- **Request Body:**\n  ```json\n  {\n\n  }\n  ```\n\n- **Response:**\n  ```json\n    {\n        \"confirmationCode\": \"\u003ccode\u003e\"\n    }\n  ```\n\n### User Authentication\n\n#### POST `/api/auth/signup`\ncreate user\n\n- **Request Body:**\n  ```json\n  {\n    \"email\": \"\u003cemail\u003e\",\n    \"password\": \"\u003cpassword\u003e\"\n  }\n  ```\n\n- **Response:**\n  ```json\n    {\n        \"user\": {\n            \"id\": \"\u003cid\u003e\",\n            \"email\": \"\u003cemail\u003e\",\n            \"password\": \"\u003chashedPassword\u003e\",\n            \"createdAt\": \"\u003ccreatedAt\u003e\",\n            \"updatedAt\": \"\u003cupdatedAt\u003e\"\n        },\n    }\n  ```\n\n#### POST `/api/auth/login`\nAuthenticate user using credentials.\n\n- **Request Body:**\n  ```json\n  {\n    \"email\": \"\u003cemail\u003e\",\n    \"password\": \"\u003cpassword\u003e\"\n  }\n  ```\n\n- **Response:**\n  ```json\n    {\n        \"user\": {\n            \"id\": \"\u003cid\u003e\",\n            \"email\": \"\u003cemail\u003e\",\n            \"password\": \"\u003chashedPassword\u003e\",\n            \"createdAt\": \"\u003ccreatedAt\u003e\",\n            \"updatedAt\": \"\u003cupdatedAt\u003e\"\n        },\n        \"token\": \"\u003ctoken\u003e\"\n    }\n  ```\n\n  #### POST `/api/auth/logout`\n\n- **Response:**\n  ```json\n  {\n    \"message\": \"Logged Out Successfully\"\n  }\n  ```\n\n---\n\n## Running Tests\n\nYou can use tools like **Postman** or **cURL** to test the endpoints.\n\n**Postman Link** -  `https://assignment-7873.postman.co/workspace/Assignment-Workspace~b4804b6c-c9aa-4dc8-9ecc-51d60bf895cc/collection/35181588-b49e3b3e-1cc8-455b-8d6b-908b2eda02f0?action=share\u0026creator=35181588`\n\n---\n\n\n## Deployed Links\n\n**Backend Url** -  ``\n\n---\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmdmassum%2Fupraised-assignment","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmdmassum%2Fupraised-assignment","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmdmassum%2Fupraised-assignment/lists"}