🌎 Welcome to the Trybesmith API Repository

This is an API with a medieval item store database.

ℹ️ Summary

I developed this application in the back-end module by Trybe. Being developed in Node.js using Sequelize ORM for operations to create products and also login using Bcript cryptography, following the principles of a RESTful API with layered architecture (MVC).

🚀 Technology Used

💻 Opening API

copy the repository to a local folder using the terminal and passing the command:
```
git clone git@github.com:juliomatiastrybe/trybesmith.git
```
If you don't have git installed, you can install it using this command in the shell and bash terminal:

Debian/Ubuntu bash:
```
apt-get install git
```
other kernel follow the instructions on the website Git.

windows/powershell:
```
winget install --id Git.Git -e --source winget
```
Or you can follow the website git documentation for more installation means.

🔍️ navigate to the folder created in the clone, and open the terminal.

install the dependencies:
```
npm install
```
This method of installing pending issues only works if the node installation package is npm, if you use another one, just switch to npm for the package used

you need to have node installed to be able to install the dependency packages If you don't have it, you can run the command if your operating system is Linux:
```
sudo apt update sudo apt install nodejs sudo apt install npm
```
If not, follow the installation instructions on the Node.js website.

⚠️ For the application to run correctly, the node version must be >= 16.

⚠️ It's also important to remember that to run an API using Docker, you'll need to have it installed and configured on your machine. Consult the documentation to learn more about Docker. In addition to having docker-compose installed and configured on your computer. To install for your operating system version click here Docker Compose.

🐋 Docker

⚠️ Before you begin, your docker-compose needs to be at version 1.29 or higher. See here or in the documentation how to install it. In the first article, you can replace where it is with 1.26.0 with 1.29.2.

⚠️ It's important to note that the containers will run on port 3001 for the API and 3306 for the MySQL database. Therefore, if you're using them, make sure to first terminate any apps or processes that utilize these ports.

For the API to start working, you first have to run docker-compose:
```
docker-compose up -d
```
When executing this command, wait for the API to become functional. checking through the blogs_api container log with the command:
```
docker logs trybesmith_api
```
When typing this command, a log should appear in the terminal with the same information as in the image below. Showing that the API is operational.
If you need to reset the API, run the command:
```
npm run db:reset
```
To stop the API, run the command:
```
docker-compose down
```

💻 Terminal

After cloning and accessing the project directory. Install dependencies with npm install if you have not already installed dependencies.

Run in the terminal:
```
docker-compose up -d
```
⚠️Before running the command, make sure you have Docker and Docker Compose installed on your machine. If you don't have it, follow the instructions in the Docker and Docker Compose documentation.
Drop the database to avoid conflicts, run the command:
```
npx sequelize db:drop
```
And stop the API container with:
```
docker stop trybesmith_api
```
To start the API in terminal, run the command:
```
npm run dev
```

With these commands the API is functional via the terminal.

To stop the API in terminal, press Ctrl + C or case macOS Cmd + C.
And stop the API container with:
```
docker-compose down
```

📚 API Documentation

📕 Swagger

To access the API documentation, you can use Swagger. Swagger is a powerful tool that allows you to visualize and interact with APIs. It provides a user-friendly interface where you can explore the available endpoints, view request and response examples, and even test the API directly from the documentation.

To use the Swagger documentation for this API, follow these steps:
1. Start the API server by uploading the containers with docker-compose up -d in the terminal.
2. Open your web browser and navigate to http://localhost:3001/api-doc/.
3. You will see the Swagger UI interface, which displays all the available endpoints and their details.
4. Explore the different endpoints, request parameters, and response schemas to understand how to interact with the API.
5. You can also try out the API directly from the documentation by clicking on the "Try it out" button and providing the required input data.
6. Swagger will generate the request URL and show the response data, making it easy to test and validate the API's functionality.
Using Swagger documentation is a great way to understand and utilize the features of this API. It provides a comprehensive overview of the available endpoints and their functionalities, making it easier for developers to integrate and work with the API.

🧪 Tests

See about

The API has unit testing coverage using mocha and sinon to simulate returns. If you want to see, just run the command:
```
npm run test:local
```
It is also possible to see test coverage using the command:
```
npm run test:coverage
```

👊 Authors and acknowledgment

This project was followed by requirements pre-established by Trybe, only the implementations are my own.

🔒️ License ©️

ISC

juliomatiastrybe / trybesmith