Simple messaging API built on NodeJs runtime and comes with authentication feature, it's not a real-time system and it may have a lot of flaws, but it'll be continuously developed
Before making an installation, make sure you have the following requirements:
- Node Js installed on your machine
- NPM (Node Package Manager), basically it'll be installed automatically within the NodeJs
- MySQl database
- Git installed on your computer
To install the project, here is the step
- Clone the project with command
git clone https://github.com/achjailani/messaging-engine.git
- Change directory, I assume the folder name is messaging-engine
cd messaging-engine
- Install required packages
npm install
, wait for till it done - Duplicate
.env.example
file and rename it to.env
- Configure the database connection and other configuraions in
.env
file - Migrate the miration files to generate all required tables
npx sequelize db:migrate
- And here we go, now we can run it with command
npm run happy5:dev
for development and andnpm run happy5:prod
for production
API Documentation could be found here or yaml file here, this file was exported from Insomnia
- NodeJs as a Backend
- ExpressJs is a NodeJs slim framework
- MySql as a Databased Used
- Json Web Token is a package for aunthentication
- Dotenv as package used to load environment variables from .env file
- Mysql2 is a mysql driver to MySql database
- Sequelize is an ORM package (Object Relational Mapping) for NodeJs
- validatorJs is package for validator
- Cors is a package to handle Cors