/notesa-app-server

Restful API for notesa-app

Primary LanguageJavaScript

Notesa-App REST API

Release Version Node JS GitHub repo size GitHub contributors GitHub stars GitHub forks

Table of Contents

Prerequiste

  • Node.js - Download and Install Node.js.
  • MySQL - Download and Install MySQL - Make sure it's running on the default port.
  • Redis - Download and Install Redis

Installation

Clone

$ https://github.com/algol007/arkademy-week8.server.git
$ cd arkademy-week8.server
$ npm install

Create Environment Variable

$ touch .env
$ nano .env

PORT = YOUR_PORT
SECRET_KEY = YOUR_SECRET_KEY

EMAIL = YOUR_EMAIL
PASS = YOUR_PASSWORD

DB_USER = YOUR_DB_USERNAME
DB_PASS = YOUR_DB_PASSWORD
DB_NAME = YOUR_DB_NAME

BASE_URL = YOUR_SERVER_URL
CLIENT_URL = YOUR_CLIENT_URL

Start Development Server

$ npm run serve

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

Fork the Project

  1. Create your Feature Branch git checkout -b [feature]
  2. Commit your Changes git commit -m 'Add some feature'
  3. Push to the Branch git push origin [feature]
  4. Open a Pull Request