{"id":15324569,"url":"https://github.com/mrinjamul/pocket-memory","last_synced_at":"2025-03-17T02:24:31.490Z","repository":{"id":223544981,"uuid":"755490695","full_name":"mrinjamul/pocket-memory","owner":"mrinjamul","description":"A Photo Gallery App","archived":false,"fork":false,"pushed_at":"2024-02-21T23:55:46.000Z","size":242,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-23T12:15:36.843Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://pocket-memory.onrender.com","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/mrinjamul.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":"2024-02-10T11:24:00.000Z","updated_at":"2024-04-18T10:37:26.000Z","dependencies_parsed_at":"2024-02-20T20:27:42.423Z","dependency_job_id":"23ff8eb0-21a4-437b-8601-493a6874e134","html_url":"https://github.com/mrinjamul/pocket-memory","commit_stats":{"total_commits":36,"total_committers":1,"mean_commits":36.0,"dds":0.0,"last_synced_commit":"5560626d93bdd23311bf81b9d4bb9cf732f26e1f"},"previous_names":["mrinjamul/pocket-memory"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mrinjamul%2Fpocket-memory","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mrinjamul%2Fpocket-memory/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mrinjamul%2Fpocket-memory/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mrinjamul%2Fpocket-memory/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mrinjamul","download_url":"https://codeload.github.com/mrinjamul/pocket-memory/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243960637,"owners_count":20375108,"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":"2024-10-01T09:27:16.132Z","updated_at":"2025-03-17T02:24:31.433Z","avatar_url":"https://github.com/mrinjamul.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Pocket Memory: A gallery App\n\nYour one-stop solution for organizing and storing memories!\n\n# How to run this project?\n\nFirst, clone the repository,\n\n```\ngit clone https://github.com/mrinjamul/pocket-memory\n```\n\n```\ncd pocket-memory\n```\n\nInstall npm packages,\n\n```\nnpm install\n```\n\nCopy environment file,\n\n```\ncp .env{.example,}\n```\n\nFill the environment files with the required values.\n\nTo run the backend server,\n\n```\nnpm run dev\n```\n\nNow, Install the frontend npm packages\n\n```\ncd ui \u0026\u0026 npm install\n```\n\nCopy environment file,\n\n```\ncp .env{.example,}\n```\n\nRun the frontend,\n\n```\nnpm run dev\n```\n\n# API documentations\n\n## Authentication Endpoints\n\n### Sign Up\n\n- **Method:** POST\n- **Endpoint:** /auth/signup\n- **Description:** Register a new user.\n- **Request Body:**\n\n  - `name`: (string): Full name\n  - `username` (string, required): Username of the user.\n  - `email` (string, required): Email address of the user.\n  - `password` (string, required): Password for the user account.\n\n  Example,\n\n```\n{\n\t\"name\":\"Injamul M.\",\n\t\"username\":\"injamul\",\n\t\"email\":\"injamul@example.com\",\n\t\"password\":\"password\"\n}\n```\n\n- **Response:**\n  - `status`: (boolean): status of the request\n  - `data`(object): return the user data (object).\n\n### Login\n\n- **Method:** POST\n- **Endpoint:** /auth/login\n- **Description:** Log in an existing user.\n- **Request Body:**\n  - `username` (string, required): Username of the user.\n  - `email`: (string): Email of the user.\n  - `password` (string, required): Password for the user account.\n\nExample,\n\n```\n{\n\t\"username\":\"injamul\",\n\t\"password\":\"password\"\n}\n```\n\n- **Response:**\n  - `status`: (boolean): status of the request\n  - `token` (string): JWT token for authenticated access.\n  - `data`(object): return the user data (object).\n\n### Logout\n\n- **Method:** GET\n- **Endpoint:** /auth/logout\n- **Description:** Log out the currently authenticated user.\n- **Response:**\n  - `status`: (boolean): status of the request\n  - `` (string): JWT token for authenticated access.\n  - `message`(string): response with message.\n\n## User Endpoints\n\n### Get User by Username\n\n- **Method:** GET\n- **Endpoint:** /api/v1/user/:username\n- **Description:** Retrieve user details by username.\n- **Parameters:**\n  - `username` (string, required): Username of the user.\n- **Response:**\n\n  - `status`: (boolean): status of the request\n  - `data`: (object) User object containing username, email, etc.\n\n### Upload Avatar\n\n- **Method:** POST\n- **Endpoint:** /api/v1/avatar/upload\n- **Description:** Upload a new avatar for the currently authenticated user.\n- **Request Body:** Form Data\n  - `avatar` (file, required): Avatar image file.\n- **Authorization Header:** Bearer Token\n\n### Get Avatar by File Name\n\n- **Method:** GET\n- **Endpoint:** /api/v1/avatar/:file\n- **Description:** Retrieve the avatar image file by its filename.\n- **Parameters:**\n  - `file` (string, required): Name of the avatar image file.\n\n## Picture Endpoints\n\n### Upload Picture\n\n- **Method:** POST\n- **Endpoint:** /api/v1/picture/upload\n- **Description:** Upload a new picture.\n- **Request Body:** Form Data\n  - `picture` (file, required): Picture image file.\n- **Authorization Header:** Bearer Token\n\n### Get All Pictures\n\n- **Method:** GET\n- **Endpoint:** /api/v1/picture\n- **Description:** Retrieve all pictures.\n- **Response:**\n  - Array of picture objects.\n\n### Get Pictures by User\n\n- **Method:** GET\n- **Endpoint:** /api/v1/picture/u/:username\n- **Description:** Retrieve pictures uploaded by a specific user.\n- **Parameters:**\n  - `username` (string, required): Username of the user.\n- **Response:**\n  - Array of picture objects.\n\n### Get Picture by File Name\n\n- **Method:** GET\n- **Endpoint:** /api/v1/picture/:file\n- **Description:** Retrieve a picture by its filename.\n- **Parameters:**\n  - `file` (string, required): Name of the picture file.\n\n### Update Picture\n\n- **Method:** POST\n- **Endpoint:** /api/v1/picture/:id\n- **Description:** Update a picture by its ID.\n- **Parameters:**\n  - `id` (string, required): ID of the picture.\n- **Request Body:**\n  - Updated picture data.\n- **Response:**\n  - Updated picture data.\n- **Authorization Header:** Bearer Token\n\n### Delete Picture\n\n- **Method:** DELETE\n- **Endpoint:** /api/v1/picture/:id\n- **Description:** Delete a picture by its ID.\n- **Parameters:**\n  - `id` (string, required): ID of the picture.\n- **Response:**\n  - Deleted picture data.\n- **Authorization Header:** Bearer Token\n\n## Copyright\n\nInjamul Mohammad Mollah (c) 2024 mrinjamul(at)gmail(dot).com\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmrinjamul%2Fpocket-memory","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmrinjamul%2Fpocket-memory","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmrinjamul%2Fpocket-memory/lists"}