Chat Realtime

An API for a realtime Chat, with this API you can create a user, and send messages in a global chat.
Have a question? · Request Feature

• Technologies
• Getting Started
  • Prerequisites
  • Installation
  • Usage
• Contributing
• Author

Technologies

This project was built using the Node.js runtime and the Express.js framework, with TypeScript used as the primary language. To handle database operations, the project uses the Prisma ORM, with MySQL as the database management system. For testing purposes, Vitest was used.

Getting Started

Prerequisites

For run this project, you will need the following things:

• Node.js
• NPM
• Docker (Necessary for tests)
• Docker Compose (Necessary for tests)

And you need to download the project in your computer.

Installation

After fill all requirements, you need to run one of the following commands for install the modules.

npm install

Usage

For use the project you need to run following command:

npm run dev

Contributing

If you'd like to contribute to this project, please follow these steps:

1. Fork this repository.
2. Create a branch: git checkout -b feature/your-feature.
3. Make your changes and commit them: git commit -m 'Add some feature'.
4. Push to the original branch: git push origin feature/your-feature.
5. Create a pull request.

Author

_{Julio Martins}

Make by Julio Martins 👋🏽 Contact me!

(back to top)