Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

project-mongo-api #508

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open

project-mongo-api #508

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
eaeeb9c
initial commit
zoe-lindqvist Dec 11, 2024
2036c35
connected the application to MongoDB Atlas using Mongoose
zoe-lindqvist Dec 12, 2024
8fad923
add a readme
zoe-lindqvist Dec 12, 2024
26b4ff4
debug
zoe-lindqvist Dec 12, 2024
6dc2db5
typos
zoe-lindqvist Dec 13, 2024
20f0c07
correct readme
zoe-lindqvist Dec 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 18 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,26 @@
# Project Mongo API

Replace this readme with your own information about your project.

Start by briefly describing the assignment in a sentence or two. Keep it short and to the point.
This project focuses on creating a RESTful API using Express and Mongoose to interact with a MongoDB database. The API allows users to perform CRUD operations on a dataset, making it accessible via multiple endpoints. The database is hosted on MongoDB Atlas and the API is deployed on Render for public accessibility.

## The problem

Describe how you approached to problem, and what tools and techniques you used to solve it. How did you plan? What technologies did you use? If you had more time, what would be next?
The task was to build an API that provides structured data responses from a database, ensuring the following:

- Database modeling with Mongoose schemas and models.
- Seeding the database using a function to load JSON data into MongoDB Atlas.
- RESTful endpoints for retrieving collections (GET /books) and single items (GET /books/ :id) and for adding new entries (POST /books).
- Deployment on Render and connected it to a MongoDB Atlas database for scalability and accessibility.

## Tools and Technologies

- Backend: Node.js, Express.js
- Database: MongoDB Atlas, Mongoose
- Deployment: Render
- Testing: Postman
- Additional Libraries: dotenv, cors, body-parser, express-list-endpoints

## View it live

Every project should be deployed somewhere. Be sure to include the link to the deployed project so that the viewer can click around and see what it's all about.
https://project-mongo-api-pbzi.onrender.com/
https://project-mongo-api-pbzi.onrender.com/books/
https://project-mongo-api-pbzi.onrender.com/books/675b270be387aacf002d49f9
Loading