Meow Server

Table of Contents

• Meow Server
  • Technologies
  • Getting started
    • Requirements

Technologies

Technologies that I used to develop the REST API

• Node.js
• Express
• MySQL
• Prisma
• Mocha
• Chai
• JWT

Getting started

Requirements

• Node.js
• npm
• One instance of MySQL

1. Clone the project and access the folder

git clone https://github.com/mohannadzidan/meow-server

2. install dependencies

npm install

3. Create the database using the sql queries at create-database.sql
4. Create .env file inside the project folder

SECRET = {YOUR_PRIVATE_KEY}
MEOW_SERVER_ADDRESS = {IP_ADDRESS}
MEOW_SERVER_PORT = {PORT}
DATABASE_URL = mysql://{USERNAME}:{PASSWORD}@localhost:3306/meowdb
# set node_env to development or production
NODE_ENV = development

5. run the server

npm run server
# or for development with nodemon
npm run start

6. run the tests

npm run test

REST API reference in wiki