Revochat / API

The Revochat API HTTP/Socket Oriented

Home Page:https://revochat.org

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Table of content

Introduction

API for the Revochat project, this API is made with NodeJS and Typescript, it uses MongoDB as a database.

Installation

Make sure you have installed typescript on your system and npm, then head over to the root of the project and type npm install
You need to create a .env file and add the mongodb tokens in it, you can find the .env.example file in the root of the project.

If you have any problems with the installation, you can open an issue in this repository.

Usage

Run nodemon index.ts to run the project !

Compiling

Run tsc --outDir ./dist to compile the project, the compiled files will be in the dist folder.

Contributing

If you want to contribute to this project you can fork this repository and make a pull request with your changes. Anyone is welcome to contribute to this project.

License

This project is under the MIT license.

About

The Revochat API HTTP/Socket Oriented

https://revochat.org


Languages

Language:TypeScript 99.2%Language:Dockerfile 0.8%