https://github.com/markalbrand56/reading-planner-api

REST API for Reading-Planner app using MongoDB and Go
https://github.com/markalbrand56/reading-planner-api

api rest-api

Last synced: 9 months ago
JSON representation

REST API for Reading-Planner app using MongoDB and Go

• Host: GitHub
• URL: https://github.com/markalbrand56/reading-planner-api
• Owner: markalbrand56
• License: gpl-3.0
• Created: 2022-08-26T22:59:11.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2023-06-04T21:50:55.000Z (about 3 years ago)
• Last Synced: 2025-01-15T18:39:34.960Z (over 1 year ago)
• Topics: api, rest-api
• Language: Go
• Homepage:
• Size: 47.9 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Reading-Planner-API

![Go](https://img.shields.io/badge/Go-00ADD8?style=for-the-badge&logo=go&logoColor=white)

![MongoDB](https://img.shields.io/badge/MongoDB-4EA94B?style=for-the-badge&logo=mongodb&logoColor=white)

REST API designed for a *reading planner*. The project's objective is to track the user on the books that are currently being read and the ones that are on the queue. It will allow the user to add new books, and track when the user reads them.

## Model Design

For this project, an API must be design to handle all the information about the books. The following will be the basic information handled by the API:

```

{

  ID

  Title

  Author

  Volume

  Progress

}

```

## Database

All the information needs to be stored somehow, so the database used for this project will be:

**Mongo DB**

This database was chosen thanks to its flexibility, ease to use, and the offer of a free plan.