Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ror2022/ror-api
Nest RorApi
https://github.com/ror2022/ror-api
azure-storage bcrypt jwt mongodb nestjs nodemailer typescript
Last synced: about 1 month ago
JSON representation
Nest RorApi
- Host: GitHub
- URL: https://github.com/ror2022/ror-api
- Owner: ROR2022
- Created: 2024-08-25T17:56:56.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-09-04T10:41:38.000Z (3 months ago)
- Last Synced: 2024-10-11T04:01:52.679Z (about 1 month ago)
- Topics: azure-storage, bcrypt, jwt, mongodb, nestjs, nodemailer, typescript
- Language: TypeScript
- Homepage: https://ror-api-production.up.railway.app/
- Size: 2.9 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
API Documentation - ROR
Overview
This API is developed using NestJS, a progressive Node.js framework that allows the creation of scalable and efficient applications. The API follows SOLID principles to ensure maintainable and extensible code. It is designed to serve as the backend for several frontend applications developed with Next.js, including Estetica Pink, Endodoncista-Cuernavaca, and Pediatra-Cuernavaca.
Main Modules
1. AppModule
The AppModule is the root module of the application, responsible for orchestrating and interconnecting the other modules. It is the foundation on which the application is built, allowing the integration of all services and functionalities provided by the API.
2. AuthModule
The AuthModule manages everything related to authentication and authorization of users. It implements a system based on JWT (JSON Web Tokens) to handle user sessions, ensuring secure access to the API's various routes and resources. User passwords are securely stored in the database using bcrypt for hashing, ensuring their confidentiality.
3. UsersModule
The UsersModule is responsible for managing the User entity, providing services for the creation, updating, retrieval, and deletion of users. This module is designed to efficiently handle the CRUD (Create, Read, Update, Delete) operations associated with the application's users, ensuring data integrity and consistency.
4. VerificationModule
The VerificationModule handles user verification, focusing particularly on email confirmation. It uses the Nodemailer tool to send verification emails to users, ensuring that only verified users can access certain functionalities of the application.
5. ReviewsModule
The ReviewsModule groups the necessary services for managing user reviews. This module allows users to create, update, retrieve, and delete reviews, providing a simple and efficient interface for handling feedback and ratings in the various applications that use this API.
Integration with Frontend Applications
The API is designed to integrate efficiently with frontend applications developed in Next.js. Some of the applications currently using this API include:
Estetica Pink: An application oriented towards the beauty and aesthetics sector.
Endodoncista-Cuernavaca: A platform focused on managing appointments and reviews for an endodontics clinic.
Pediatra-Cuernavaca: An application aimed at managing patients and reviews in a pediatric clinic.
Technical Considerations
Database: The API uses MongoDB as the primary database system, leveraging its flexibility and scalability to handle unstructured data.
Security: Best security practices are implemented, such as encrypted password storage and user validation through email.
Architecture: The API follows a modular approach, making it easy to maintain and scale, allowing functionalities to be added or modified without affecting the overall system.
[circleci-image]: https://img.shields.io/circleci/build/github/nestjs/nest/master?token=abc123def456
[circleci-url]: https://circleci.com/gh/nestjs/nest
A progressive Node.js framework for building efficient and scalable server-side applications.
## Description
[Nest](https://github.com/nestjs/nest) framework TypeScript starter repository.
## Installation
```bash
$ npm install
```
## Running the app
```bash
# development
$ npm run start
# watch mode
$ npm run start:dev
# production mode
$ npm run start:prod
```
## Test
```bash
# unit tests
$ npm run test
# e2e tests
$ npm run test:e2e
# test coverage
$ npm run test:cov
```
## Support
Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please [read more here](https://docs.nestjs.com/support).
## Stay in touch
- Author - [Kamil Myśliwiec](https://twitter.com/kammysliwiec)
- Website - [https://nestjs.com](https://nestjs.com/)
- Twitter - [@nestframework](https://twitter.com/nestframework)
## License
Nest is [MIT licensed](https://github.com/nestjs/nest/blob/master/LICENSE).