user-registration-api

Table of Contents

• About the Project
• Technologies Used
• Prerequisites
• Installation
• Usage
• Insomnia File
• Contribution
• License
• Contact

About the Project

This project focuses on using Prisma ORM for database interaction in Node.js applications. The goal is to demonstrate how to set up and use Prisma in a modern development environment.

Technologies Used

• Node.js
• Prisma ORM
• Docker
• Yarn
• Express
• Bcrypt
• Cors
• Dotenv
• Sucrase (for development)
• Nodemon (for development)

Prerequisites

Before starting, make sure you have installed on your machine:

• Node.js (version 12 or higher)
• Yarn
• Docker
• Git

Installation

1. Start your Docker Desktop.

2. Clone the repository:

   git clone https://github.com/mdanieldantas/API-Cadastro.git
   

3. Navigate to the project directory:

   cd user-registration-api
   

4. Install dependencies:

   yarn install
   

5. Start the Docker environment:

   docker-compose up
   

6. Set up Prisma:

   npx prisma migrate dev --name init
   

Usage

1. To start the development server:

   yarn start
   

Insomnia File

The insomnia.json file exports various information from Insomnia, including:

1. Requests: Details about the HTTP requests created, such as URLs, methods (GET, POST, etc.), headers, and request body.

2. Environments: Environment configurations, including variables used in requests.

3. Collections: Organization of requests into folders or groups.

4. Authentication: Information about authentication methods used in requests.

5. Cookies: Cookie data associated with requests.

This file is useful for sharing and importing Insomnia configurations among team members or development environments.

Contribution

Contributions are always welcome! Please follow these steps:

1. Fork the project.
2. Create your feature branch: git checkout -b my-new-feature.
3. Commit your changes: git commit -m 'Add some feature'.
4. Push to the branch: git push origin my-new-feature.
5. Open a Pull Request.

License

This project is licensed under the MIT License. See the LICENSE file for more details.

Contact

M. Daniel Dantas

LinkedIn: https://www.linkedin.com/in/mdanieldantas

Email: contatomarcosdgomes@gmail.com

Project Link: https://github.com/mdanieldantas/API-Cadastro.git