API TIPS - API Documentation 🤑☕

Description

This is the API for the TIPS application. It is a RESTful API built with Node.js, Express, and MySQL. It is used to store and retrieve data for the TIPS application.

Getting Started

These instructions will help you set up and run the API on your local machine for development and testing purposes.

Prerequisites

Ensure that you have the following software installed on your machine:

• Node.js
• npm (Node Package Manager) - comes with Node.js
• Postman - for testing API endpoints
• XAMPP - for running MySQL database

Installing

Follow these steps to install and run the API:

1. Clone the repository to your local machine git clone https://github.com/GetLoloed/api-tips.git
2. Open the project folder in your terminal cd api-tips
3. Run npm install to install all dependencies
4. Run npm start to start the server or npm run dev to start the server with nodemon

The API should now be running on http://localhost:3000.

API Documentation

You can access the Swagger documentation for the API by navigating to http://localhost:3000/api-docs in your browser.

Running the tests

To run the tests, run npm test in your terminal.

Built With

• Node.js - JavaScript runtime
• Express - Web framework for Node.js
• Sequelize - ORM for Node.js
• MySQL - Database
• Swagger - API documentation
• jest - Testing framework
• [supertest] - Testing framework