Node.js - MySQL - API Rest

Welcome to our Node.js - MySQL - API Rest project! This project is designed to showcase a modern approach to building RESTful APIs using Node.js and MySQL, providing a robust backend solution for web applications.

Features

• RESTful API Design: Implement standard REST practices for efficient data handling.
• MySQL Database Integration: Utilize MySQL for robust data storage and management.
• Express Server: Fast and lightweight web server using Express.js.
• Environment Variable Management: Use dotenv for managing environment variables securely.
• Auto-reload Development: Utilize Nodemon for automatic server restarts during development.

Getting Started

• Clone the Repository:

  git clone https://github.com/JuanCarlosGP/nodejs_mysql_restapi

• Select Folder:

  cd nodejs_mysql_restapi

• Install Dependencies:

  npm install

• Start the Application:

  npm run dev

Note: Prerequisites.

• Node.js: Required to run the project and manage packages.
• MySQL: The project uses MySQL as its database.
• Git: Git is needed to clone the repository and manage versions.

Additional Setup:

• Initialize the Project:

  npm init -y

• Install Express:

  npm i express

• Install MySQL Connection Module:

  npm i mysql2

• Install Dotenv for Environment Variables:

  npm i dotenv

• Database Setup:

  Create the database using the SQL file located at ./db/database.sql.

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

• Fork the Project
• Create your Feature Branch (git checkout -b feature/AmazingFeature)
• Commit your Changes (git commit -m 'Add some AmazingFeature')
• Push to the Branch (git push origin feature/AmazingFeature)
• Open a Pull Request

Preview

Contact

Name - @JuanCarlosGP

Demo

Project Link: