help-house-api

This API assists an Android application called Help House.

The routes defined in the API are specific routes for use within the application.

Installation / How to use

First you have cloned this repos.
Then, in the path of the folder where the clone was made, run the following commands in order.

Install the app dependencies

npm install

Create Database

Use the db_HelpHouse.sql script on the db folder of the project to create the Mysql database.

Configure Environment Variables

If you are Windows user, you just need to create a .env file on the API folder.
If you are a Linux user, you can use one of the following commands to create the .env file.

gedit .env

vim .env

After creating after having created in the .env file enter SQL server credentials.
Example

DB_CONNECTION_LIMIT=100
DB_HOST=[your_host_name]
DB_USER=[your_user_name]
DB_PASSWORD=[your_password]
DB_CENTRAL_DATABASE=db_masrapt

Run the API

Normal run

npm start

Run on a Apache Server

sudo npm start

License

This repo use MIT License.

"The code needs to go through different approaches before it is as effective as possible"

robertocarlosmedina/help-house-api