Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nadjascodejourney/backendproject-birdsofprey-api
Backend for an api for the management of raptor data. It enables the storage and management of information on birds of prey.
https://github.com/nadjascodejourney/backendproject-birdsofprey-api
api axios backend-api bcrypt dotenv etheral expressjs helmet jest jwt mongodb-database mongoose nodejs nodemailer supertest zod
Last synced: 7 days ago
JSON representation
Backend for an api for the management of raptor data. It enables the storage and management of information on birds of prey.
- Host: GitHub
- URL: https://github.com/nadjascodejourney/backendproject-birdsofprey-api
- Owner: nadjascodejourney
- Created: 2024-07-08T08:54:30.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-07-22T12:32:49.000Z (5 months ago)
- Last Synced: 2024-10-29T14:20:44.932Z (about 2 months ago)
- Topics: api, axios, backend-api, bcrypt, dotenv, etheral, expressjs, helmet, jest, jwt, mongodb-database, mongoose, nodejs, nodemailer, supertest, zod
- Language: JavaScript
- Homepage:
- Size: 1020 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Building an API for CRUD Operations with birds of prey data
This repository contains the backend for an API managing information about birds of prey. It will allow retrieving bird of prey and falconries data, as well as adding, updating, and deleting entries. Additionally, users can log bird watching observations, and administrators have the ability to manage regional falconries.
## Used Technologies & Libraries:
- Node.js: JavaScript runtime environment for server-side development.
- [Express.js](https://www.npmjs.com/package/express): Fast, minimalist web framework for Node.js.
- MongoDB: NoSQL database for storing bird of prey data, falconries and users.
- [Mongoose](https://www.npmjs.com/package/mongoose): MongoDB object modeling.
- crypto: provides cryptographic functions for Node.js applications, offering capabilities like secure random number generation.
- [Zod](https://www.npmjs.com/package/zod): Schema Declaration and validation library, used it for validation.
- [Jest](https://www.npmjs.com/package/jest): JavaScript testing framework.
- [supertest](https://www.npmjs.com/package/supertest): SuperAgent-driven library for testing HTTP servers.
- [cors](https://www.npmjs.com/package/cors): Express middleware for handling Cross-Origin Resource Sharing.
- [helmet](https://www.npmjs.com/package/helmet): to set secure HTTP headers.
- [bcrypt](https://www.npmjs.com/package/bcrypt): a library to hash passwords.
- [cookie-parser](https://www.npmjs.com/package/cookie-parser): to parse Cookie header and to use them in the req.cookies object.
- [jwt](https://www.npmjs.com/package/jsonwebtoken): to create, sign, verify and decode JSON Web Tokens, enabling authentication and secure data exchange in web-Apps
- [dotenv](https://www.npmjs.com/package/dotenv): loads environment variables from a .env file into process.env, making them accessible
- [nodemailer](https://www.npmjs.com/package/nodemailer): for sending emails
- [axios](https://www.npmjs.com/package/axios): Promise based HTTP client for the browser and node.js
- [Etheral](https://ethereal.email/): a free, fake SMTP service, good for testing E-Mail Services with nodemailer
## Simplified Flowchart
## How to install and run this project locally
If you´d like to take a deeper look into this project, follow these steps:
1. **Clone or Fork the Repository** and navigate to the project
Please note that at the moment the project will not work completely on your computer without an own database connection to MongoDB.
If you want to try it out yourself with your own data, you need an account with MongoDB.
However, you are welcome to clone the project to get a deeper insight into the code.
2. **Install the Dependencies** with the node package manager by running the following commands:
```js
npm install
´´´
```
You also need a fake account with Etheral to test the email verification. To test the API Requests, I recommend using Postman. Postman is a popular collaboration platform for API development that simplifies the process of building, testing, and documenting APIs. I used it during Production and it was very helpful. As an alternative, you can also try Thunderclient in VSCode.
3. **Start the server and the client** in a respective terminal
```js
node server.js
node client.js
´´´
```
This project also contains a notes.md file in which I have recorded many notes, learnings and helpful information about this project or individual steps.