{"id":19899155,"url":"https://github.com/samrb-dev/nomsnbits-rest-api","last_synced_at":"2026-04-10T07:09:43.115Z","repository":{"id":132414702,"uuid":"600668700","full_name":"SamRB-dev/NomsnBits-REST-API","owner":"SamRB-dev","description":"REST API for my Noms\u0026Bits Recipe Website project. Tech stack ? PE(?)N :b Postgres, Express, ? (React/Vue idk), NodeJs","archived":false,"fork":false,"pushed_at":"2023-02-23T03:55:14.000Z","size":1265,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-11T20:44:26.372Z","etag":null,"topics":["expressjs","nodejs","nodejs-api","postgresql","rest","restapi"],"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/SamRB-dev.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":"2023-02-12T07:49:59.000Z","updated_at":"2023-02-19T09:42:40.000Z","dependencies_parsed_at":null,"dependency_job_id":"2222f199-c4c6-4bda-a840-9eeed664fdd6","html_url":"https://github.com/SamRB-dev/NomsnBits-REST-API","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SamRB-dev%2FNomsnBits-REST-API","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SamRB-dev%2FNomsnBits-REST-API/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SamRB-dev%2FNomsnBits-REST-API/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SamRB-dev%2FNomsnBits-REST-API/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SamRB-dev","download_url":"https://codeload.github.com/SamRB-dev/NomsnBits-REST-API/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241329416,"owners_count":19944984,"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":["expressjs","nodejs","nodejs-api","postgresql","rest","restapi"],"created_at":"2024-11-12T20:07:22.869Z","updated_at":"2026-04-10T07:09:43.071Z","avatar_url":"https://github.com/SamRB-dev.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Noms\u0026Bits REST API - v1.0\nThis is a RESTful API built with Node.js, Express.js and PostgreSQL that provides registration, user data retrieval, user deletion and other functionalities for the Noms\u0026Bits web application.\n\n\n## API URL\n```\n  https://nomsnbits-rest-api.onrender.com\n```\n- Deployed in [Render](https://render.com/)\n\n\n## ToDo \n- Login \u0026 Authorization\n\n\n## Getting Started\nTo get started with this project, you should have Node.js, Express.js and PostgreSQL installed on your machine. It is recommended to create a virtual environment for your project. Refer [Here](https://pypi.org/project/nodeenv/)\n\n\n## Testing\n**Client**: RESTClient on [VScode Marketplace](https://marketplace.visualstudio.com/items?itemName=humao.rest-client)\n\n\n## API Endpoints\nThis API has the following endpoints:\n\n\n-  `GET /`\n**Description**: Returns a 200 status code and a JSON message \"OK\" when the server is running.\u003cbr\u003e\n\n\n- `POST /auth/register`\n**Description**: Allows a user to register for an account with a unique username, email, and password.\n**Example**: \n  * Request \n    ```\n    POST http://URL/api/auth/register\n    Content-Type: application/json\n\n    {\n      \"username\": \"test123\",\n      \"email\": \"test123@email.com\",\n      \"password\": \"test-password\",\n      \"regDate\": \"2023-02-20\"\n    }\n    ```\n    \n  * Response \n    ```json\n    {\n        \"status\": 200,\n        \"message\": \"Successfully Registered the Account\"\n    }\n    ```\n\n- `GET /user/:username` \n**Description**: Retrieves the data of a user with the specified username.\n**Example**: \n  * Response \n  ```json\n  {\n  \"status\": 200,\n  \"data\": [\n    {\n      \"username\": \"john_doe\",\n      \"email\": \"john_doe@example.com\",\n      \"password\": \"$2b$08$7z1Mx.McDCMzQyjYKj7.3uJqfkB7V2OZJb9X9q3CmrsKzdOwNUy8W\",\n      \"registration_date\": \"2022-01-11\"\n      }\n    ]\n  }\n  ```\n- `DELETE /user/:username`\n**Description**: Deletes the account of a user with the specified username\n**Example**: \n  * Response\n  ```json\n  {\n    \"status\": 200,\n    \"message\": \"User data has been deleted\"\n  }\n  ```\n\n- `PUT /user/:username/update-uname/:newuname`\n**Description**: Allows a user to update their username.\n**Example**: \n  * Response \n  ```json \n  {\n    \"status\": 200,\n    \"message\": \"Successfully Updated the username\"\n  }\n  ```\n\n- `PUT /user/:username/update-passwd/:newpasswd`\n**Description**: Allows a user to update their password.\n**Example**:\n  * Response \n  ```json \n  {\n    \"status\": 200,\n    \"message\": \"Successfully Updated the Password\"\n  }\n  ```\n\n- `PUT /user/:username/update-email/:newemail`\n**Description**: Allows a user to update their login email.\n**Example**: \n  * Response \n  ```json \n  {\n    \"status\": 200,\n    \"message\": \"Successfully Updated the Login Email\"\n  }\n  ```\n\n- `POST /auth/login`\n**Description**:\n**Example**: \n\n## README format\n```\n- \n**Description**:\n**Example**: \n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsamrb-dev%2Fnomsnbits-rest-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsamrb-dev%2Fnomsnbits-rest-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsamrb-dev%2Fnomsnbits-rest-api/lists"}