Backend Project using Express and Prisma

This is a backend project template built using Express.js and Prisma. It provides a foundation for developing web applications with a focus on scalability, robustness, and data management.

Introduction

Express

Express.js is a fast, unopinionated, and minimalist web framework for Node.js. It provides a set of flexible features for building web applications and APIs. Express allows you to handle routes, middleware, and HTTP requests in a simple and intuitive way.

Prisma

Prisma is an open-source database toolkit that simplifies database access for Node.js applications. It provides an Object-Relational Mapping (ORM) layer and a powerful query builder. Prisma supports multiple databases and offers features such as data modeling, schema migrations, and real-time data synchronization.

Swagger

Swagger is an open-source framework that allows developers to design, build, document, and consume RESTful APIs. It provides a user-friendly interface for interacting with APIs and generating interactive API documentation. With Swagger, you can easily visualize and test your API endpoints, explore available routes, and understand the request and response formats.

In this project, Swagger has been integrated to facilitate API documentation and exploration. Once you have the project running, you can access the Swagger documentation by navigating to http://localhost:8080/docs in your browser. This will open the Swagger UI, where you can view detailed information about the available routes, make test requests, and interact with the API.

Installation

To run this project, follow the instructions below:

Clone the repository:
```
git clone <repository-url>
```
Navigate to the project directory:
```
cd prisma-sequelize
```
Install the dependencies:
```
npm install
```
Create a .env file in the root directory and set your environment variables, refer to the .env.example file:
```
touch .env
```
Run the project:
```
npm dev
```
This command will transpile the TypeScript code and start the Express server.
Access the application in your browser at http://localhost:8080 by default.

Available Scripts

In the project directory, you can run the following scripts:

npm test: Run tests for the project.
npm start: Start the production server.
npm run seed: Run the database seed script.
npm run dev: Start the development server with automatic restart on file changes.
npm run studio: Open Prisma Studio, an interactive database GUI.

Feel free to explore and modify these scripts based on your project requirements.

License

This project is licensed under the ISC License.

Enjoy building your Express and Prisma backend application! If you have any questions, feel free to reach out.

alejandroaperez1994g/prisma-sequelize