Giter Club home page Giter Club logo

branch_backend's Introduction

Branch CRM BACKEND

A Node application that handles customers requests.

API Link

https://branchbackend.herokuapp.com/api/

API Documentation

https://documenter.getpostman.com/view/1599757/UVXqGDks

Tools

Prerequisites

The following should be installed in your machine

  • Node v16.13.0 and above if you are not using docker

To Run tests

  • npm test

How To Install And Run The Application on Local

  • Clone this Repo and cd into it
  • create the .env file in your root directory and add
  • DEV_DB_HOST=

  • DEV_DB_USER=

  • DEV_DB_PASSWORD=

  • DEV_DB_NAME=

  • DEV_DB_PORT=

  • TEST_DB_HOST=

  • TEST_DB_USER=

  • TEST_DB_PASSWORD=

  • TEST_DB_NAME=

  • TEST_DB_PORT=

  • NODE_ENV=development

  • FRONTEND_ORIGIN=

  • Install all the dependancies by running the npm install
  • Run database migrations npm run db:migrate
  • Seed database npm run db:seed
  • Start the application on development mode by running npm start
  • your origin has to refrenced in the api server though to use app

How To Install And Run The Application with docker

  • create the .env file in your root directory and add
  • MYSQLDB_USER=

  • MYSQLDB_ROOT_PASSWORD=

  • MYSQLDB_DATABASE=

  • MYSQLDB_LOCAL_PORT=

  • MYSQLDB_DOCKER_PORT=

  • NODE_LOCAL_PORT=

  • NODE_DOCKER_PORT=

  • DEV_DB_HOST=

  • DEV_DB_USER=

  • DEV_DB_PASSWORD=

  • DEV_DB_NAME=

  • DEV_DB_PORT=

  • TEST_DB_HOST=

  • TEST_DB_USER=

  • TEST_DB_PASSWORD=

  • TEST_DB_NAME=

  • TEST_DB_PORT=

  • NODE_ENV=development

  • FRONTEND_ORIGIN=

Issues

Issues are always very welcome. Please be sure to create a constructive issue when neccessary.

branch_backend's People

Watchers

Avwerosuo Igho-Godwin avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.