GithubHelp home page GithubHelp logo

amigo's Introduction

Amigo Web Service

This is a web service made up of two docker containers:

  • db - (postgres)
  • web - (nodejs)

The orchestration of which is controlled by a docker-compose file.

Getting Started

  1. Select the environment you want to run and edit the web.enironment setting in the docker-compose.yml file to one of the settings below:
Environment Setting Description
Production NODE_ENV=PROD Runs API using PM2 with watch flag disabled
Development NODE_ENV=DEV Runs API using PM2 with watch flag enabled
Testing NODE_ENV=TEST Runs an automated test suite on the API using mocha & chai
  1. Run docker-compose build
  2. Run docker-compose up

Calling th API

The API runs on http://localhost:3000 and has 3 methods

  • POST message - http://localhost:3000/messages/FOOBAR
  • GET messages - http://localhost:3000/messages/
  • GET message - http://localhost:3000/messages/1

Inspect Postgres database

Once th environment is up and running you can inspect the database by inspecting the docker container for the databases host:

  • docker inspect amigo_db_1 and connecting to the database via PGAdmin using the IPAddress and the following username and password:

  • Username: amigo

  • password: password123

amigo's People

Contributors

hloughrey avatar

Watchers

James Cloos 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.