Message Rest API Node (Noderest)

A boilerplate node js project use Node js express js Mysql and Sequilize Orm.

Introduction
Features
Prerequisites
Getting Started
- Installation
- Configuration
Usage
API Endpoints
Testing
Contributing
License
Acknowledgements

Introduction

Noderest is a boilerplate Node.js project that incorporates Node.js, Express.js, MySQL, and Sequelize ORM to provide a foundation for API development.

Features

Concisely list the key features of your project.

Prerequisites

Before you begin, ensure you have met the following requirements:

Node.js installed
npm (Node Package Manager) installed
Any other specific dependencies...

Getting Started

Installation

Clone the repository:

git clone https://github.com/dzoxploit/noderest.git
cd your-project

Install dependencies:
```
npm install
```
configure config database in folder config/config.json with your settings databases
Run migration
```
npx sequelize-cli db:migrate
```
Run Project
```
node server.js
```
default port for this project is :4000
For documentation you can import raw in postman and added file noderest.postman_collection.json

Configuration

configure config database in folder config/config.json with your settings databases this is my example

```json
    {

"development": {
"username": "root",
"password": null,
"database": "noderest",
"host": "127.0.0.1",
"dialect": "mysql"
},
"test": {
"username": "root",
"password": null,
"database": "noderest",
"host": "127.0.0.1",
"dialect": "mysql"
},
"production": {
"username": "root",
"password": null,
"database": "noderest",
"host": "127.0.0.1",
"dialect": "mysql"
}
}

```

API Endpoints

If your project includes a server or API, document the available endpoints, HTTP methods, and request/response examples.

Auth Routes

POST /api/auth/register: Register a new user.
POST /api/auth/login: Log in a user.

Profile Routes

PATCH /api/profile/update: Update user profile.

Message Routes

POST /api/messages/create: Create a new message.
GET /api/messages/all: Get all message.
GET /api/messages/:id: Get a message by ID.
PUT /api/messages/:id: Update a message by ID.
DELETE /api/messages/:id: Delete a message by ID.

Contributing

If you want to contribute to the project, please follow the guidelines outlined in CONTRIBUTING.md (create this file if needed).

License

This project is licensed under the [Your License Name] License - see the LICENSE.md file for details.

Acknowledgements

Mention any third-party libraries, tools, or resources that you used or were inspired by in your project.

dzoxploit/messageapinode