https://github.com/correia-jpv/bucket-listy-api
💡✔ Bucket list ideas REST API. Node, Express, MongoDB stack. Swagger playground. JSDoc documentation.
https://github.com/correia-jpv/bucket-listy-api
api docstrap express expressjs jsdoc mongodb mongoose nodejs rest-api swagger
Last synced: about 1 year ago
JSON representation
💡✔ Bucket list ideas REST API. Node, Express, MongoDB stack. Swagger playground. JSDoc documentation.
- Host: GitHub
- URL: https://github.com/correia-jpv/bucket-listy-api
- Owner: Correia-jpv
- License: mit
- Created: 2021-09-16T09:03:15.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2025-05-28T15:47:05.000Z (about 1 year ago)
- Last Synced: 2025-05-28T16:53:08.744Z (about 1 year ago)
- Topics: api, docstrap, express, expressjs, jsdoc, mongodb, mongoose, nodejs, rest-api, swagger
- Language: JavaScript
- Homepage: https://bucketlisty-api.herokuapp.com/docs/
- Size: 1.1 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 40
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Bucket Listy API
![Logo]
## Table of Contents
- [Introduction]
- [Demo]
- [Documentation]
- [Development]
- [Built With]
- [Future Implementation]
- [Resources]
- [Contributing]
- [License]
## Intro
This 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].
## Demo
On the [Swagger Playground] you can test the publicly available API's endpoints and their authorization filters.
## Documentation
[Here](https://bucketlisty-api.herokuapp.com/docs/jsdoc) are documented the Express.js routers and their routes, controllers and models.
## Development
These were the main requirements to fulfill when developing the API:
- MVC architecture.
- Authentication and Authorization.
- JSDoc documentation.
- Swagger UI playground.
## Built With
- [Node.js] - Back end JS runtime environment.
- [Express.js] - Back end node framework to serve the REST API.
- [MongoDB] - NoSQL database platform.
- [Mongoose] - Object Data Modeling library for MongoDB.
- [LoginRadius] - User authentication with social networks or traditional email/password.
- [Swagger UI] - Generate interactive API documentation that lets your users try out the API calls directly in the browser.
- [JSDoc] - API documentation generator for JavaScript.
- [Docstrap] - Bootstrap based template for JSDoc.
## Future Implementation
- Bucket list items categorization.
- Archives.
- Completion achievements.
## Resources
- [Heroku cloud deployment]
- [Build a CRUD REST API with Node.js, Express & MongoDB]
- [How to Document an Express API with Swagger UI and JSDoc]
## Contributing
Contributions are welcome! Read the [contribution guidelines](https://github.com/Correia-jpv/.github/blob/main/CONTRIBUTING.md) first.
Wish there was another feature? Feel free to open an [feature request issue](/../../issues/new?assignees=Correia-jpv&labels=enhancement&template=feature-request.md&title=%5BREQUEST%5D) with your suggestion!
If you find a bug, kindly open an [bug report issue](/../../issues/new?assignees=Correia-jpv&labels=bug&template=bug_report.md&title=%5BBUG%5D) as described in the contribution guidelines.
## License
[Licensed Under MIT]
[Introduction]:#Intro
[Resources]:#resources
[Contributing]:#contributing
[License]:#License
[Demo]:#Demo
[Built With]:#built-with
[Future Implementation]:#future-implementation
[Development]:#Development
[Documentation]:#documentation
[bucket list web app]:https://github.com/Correia-jpv/Bucket-Listy
[LoginRadius]:https://loginradius.com/docs/developer/tutorial/node-js
[Node.js]:https://nodejs.org/
[MongoDB]:https://mongodb.com/
[Express.js]:https://expressjs.com/
[Mongoose]:https://mongoosejs.com/
[Heroku cloud deployment]:https://www.heroku.com/nodejs
[Build a CRUD REST API with Node.js, Express & MongoDB]:https://www.bezkoder.com/node-express-mongodb-crud-rest-api/
[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
[Swagger UI]:https://swagger.io/tools/swagger-ui/
[JSDoc]:https://jsdoc.app/
[Docstrap]:https://github.com/docstrap/docstrap
[Logo]:documentation/mockup-devices.png
[issue]:https://github.com/correia-jpv/Bucket-Listy/issues/new
[BucketListy.com]:https://bucketlisty.com/
[Swagger Playground]:https://bucketlisty-api.herokuapp.com/docs
[Licensed Under MIT]:https://spdx.org/licenses/MIT.html