{"id":27720111,"url":"https://github.com/correia-jpv/bucket-listy-api","last_synced_at":"2025-06-10T15:34:54.208Z","repository":{"id":36975349,"uuid":"407095550","full_name":"Correia-jpv/Bucket-Listy-API","owner":"Correia-jpv","description":"💡✔ Bucket list ideas REST API. Node, Express, MongoDB stack. Swagger playground. JSDoc documentation.","archived":false,"fork":false,"pushed_at":"2025-05-28T15:47:05.000Z","size":1151,"stargazers_count":2,"open_issues_count":40,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-05-28T16:53:08.744Z","etag":null,"topics":["api","docstrap","express","expressjs","jsdoc","mongodb","mongoose","nodejs","rest-api","swagger"],"latest_commit_sha":null,"homepage":"https://bucketlisty-api.herokuapp.com/docs/","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/Correia-jpv.png","metadata":{"files":{"readme":"README.md","changelog":null,"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,"zenodo":null}},"created_at":"2021-09-16T09:03:15.000Z","updated_at":"2025-03-25T21:05:12.000Z","dependencies_parsed_at":"2023-11-28T16:41:38.142Z","dependency_job_id":"31f588d9-e5b9-4d8a-80bb-4098cc367ced","html_url":"https://github.com/Correia-jpv/Bucket-Listy-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/Correia-jpv%2FBucket-Listy-API","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Correia-jpv%2FBucket-Listy-API/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Correia-jpv%2FBucket-Listy-API/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Correia-jpv%2FBucket-Listy-API/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Correia-jpv","download_url":"https://codeload.github.com/Correia-jpv/Bucket-Listy-API/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Correia-jpv%2FBucket-Listy-API/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259102430,"owners_count":22805472,"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":["api","docstrap","express","expressjs","jsdoc","mongodb","mongoose","nodejs","rest-api","swagger"],"created_at":"2025-04-27T08:25:26.910Z","updated_at":"2025-06-10T15:34:54.177Z","avatar_url":"https://github.com/Correia-jpv.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Bucket Listy API\n\n![Logo]\n\n## Table of Contents\n\n- [Introduction]\n- [Demo]\n- [Documentation]\n- [Development]\n- [Built With]\n- [Future Implementation]\n- [Resources]\n- [Contributing]\n- [License]\n\n\n## Intro\n\nThis is a REST API with CRUD operations made with Node.js, Express.js, MongoDB and Mongoose. It was built to serve a [bucket list web app] at [BucketListy.com].\n\n\n## Demo\n\nOn the [Swagger Playground] you can test the publicly available API's endpoints and their authorization filters.\n\n\n## Documentation\n\n[Here](https://bucketlisty-api.herokuapp.com/docs/jsdoc) are documented the Express.js routers and their routes, controllers and models.\n\n\n## Development\n \n These were the main requirements to fulfill when developing the API:\n\n- MVC architecture.\n- Authentication and Authorization.\n- JSDoc documentation.\n- Swagger UI playground.\n\n\n## Built With\n- [Node.js] - Back end JS runtime environment.\n- [Express.js] - Back end node framework to serve the REST API.\n- [MongoDB] - NoSQL database platform.\n- [Mongoose] - Object Data Modeling library for MongoDB.\n- [LoginRadius] - User authentication with social networks or traditional email/password.\n- [Swagger UI] - Generate interactive API documentation that lets your users try out the API calls directly in the browser.\n- [JSDoc] - API documentation generator for JavaScript.\n- [Docstrap] - Bootstrap based template for JSDoc.\n\n\n## Future Implementation\n\n- Bucket list items categorization.\n- Archives.\n- Completion achievements.\n\n\n## Resources\n- [Heroku cloud deployment]\n- [Build a CRUD REST API with Node.js, Express \u0026 MongoDB]\n- [How to Document an Express API with Swagger UI and JSDoc]\n\n\n## Contributing\n\nContributions are welcome! Read the [contribution guidelines](https://github.com/Correia-jpv/.github/blob/main/CONTRIBUTING.md) first.\n\nWish there was another feature? Feel free to open an [feature request issue](/../../issues/new?assignees=Correia-jpv\u0026labels=enhancement\u0026template=feature-request.md\u0026title=%5BREQUEST%5D) with your suggestion!\n\nIf you find a bug, kindly open an [bug report issue](/../../issues/new?assignees=Correia-jpv\u0026labels=bug\u0026template=bug_report.md\u0026title=%5BBUG%5D) as described in the contribution guidelines.\n\n\n## License\n\n[Licensed Under MIT]\n\n\n\u003c!-- Links --\u003e\n\n  \u003c!-- Table of Contents --\u003e\n  [Introduction]:#Intro\n  [Resources]:#resources\n  [Contributing]:#contributing\n  [License]:#License\n  [Demo]:#Demo\n  [Built With]:#built-with\n  [Future Implementation]:#future-implementation\n  [Development]:#Development\n  [Documentation]:#documentation\n\n  \u003c!-- Intro --\u003e\n  [bucket list web app]:https://github.com/Correia-jpv/Bucket-Listy\n\n  \u003c!-- Resources --\u003e\n  [LoginRadius]:https://loginradius.com/docs/developer/tutorial/node-js\n  [Node.js]:https://nodejs.org/\n  [MongoDB]:https://mongodb.com/\n  [Express.js]:https://expressjs.com/\n  [Mongoose]:https://mongoosejs.com/\n  [Heroku cloud deployment]:https://www.heroku.com/nodejs\n  [Build a CRUD REST API with Node.js, Express \u0026 MongoDB]:https://www.bezkoder.com/node-express-mongodb-crud-rest-api/\n  [How to Document an Express API with Swagger UI and JSDoc]:https://dev.to/kabartolo/how-to-document-an-express-api-with-swagger-ui-and-jsdoc-50do\n  [Swagger UI]:https://swagger.io/tools/swagger-ui/\n  [JSDoc]:https://jsdoc.app/\n  [Docstrap]:https://github.com/docstrap/docstrap\n  [Logo]:documentation/mockup-devices.png\n\n  \u003c!-- Contributing --\u003e\n  [issue]:https://github.com/correia-jpv/Bucket-Listy/issues/new\n\n  \u003c!-- Demo --\u003e\n  [BucketListy.com]:https://bucketlisty.com/\n  [Swagger Playground]:https://bucketlisty-api.herokuapp.com/docs\n\n  \n  \u003c!-- License --\u003e\n  [Licensed Under MIT]:https://spdx.org/licenses/MIT.html\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcorreia-jpv%2Fbucket-listy-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcorreia-jpv%2Fbucket-listy-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcorreia-jpv%2Fbucket-listy-api/lists"}