#Documentation

The PROJECT API is the API of PROJECT API

Author 🚀

@SofwanCoder

---

Technologies

• Node JS
• Express
• Socket.io
• Jest
• Mysql
• NodeCron

---

Database

• Mysql

---

Install NodeJS

To Install NodeJS, kindly go to Nodejs and follow the necessary instructions required depending on your PC Operating System

MACOS

using a package simply download the installer

using homebrew

brew install node

---

Windows

using a package simply download the installer

using chocolatey to install Node

cinst nodejs

---

To install Mysql

Go to https://www.mysql.org

---

Setup Database

To setup your database for the project, after creation kindly open the .env file and update as necessary

DATABASE_URI = mysql://root:password@localhost:3306/database_name

Kindly replace these values with the appropriate values based on your Database environment

Start Development

Use this template https://github.com/SofwanCoder/node_project_api

Installation

To install the necessary packages, in your folder directory kindly run

npm i

# or

yarn add

• To continuously watch for changes

  • npm run dev

• To build your app for production

  • npm run build

• To run your app server for production

  • npm run start

• To run test cases

  • npm run test

---

Development