FAPS Demonstrator Customer App Backend

This Application serves as the backend for the FAPS Demonstrator customer App. The App is used to start and monitoring a production order to the FAPS Demonstrator. The Backend exposes a REST API to post and retrieve a list of production order. The status of a production order can also be polled via the same API. Please refer to the section

Please refer to this section to see how run the Backend as a microservice inside a docker container.

Requirements

NodeJs : The Backend requires NodeJs and a node global package npm.
Git
Dockers: Since the App need a databse, we used MongoDB that we instantiate in a docker container. Thereforre Docker is neccessary. Please refer to the docker documentation for docker installation.

Installation

Step 1: Clone this repo and install the dependencies.

git clone https://github.com/jupiterbak/FAPSDemonstratorCustomerBackend.git
cd FAPSDemonstratorCustomerBackend

npm install

Step 2: Start the MongoDB Docker container.

docker run -p 27017:27017 --name FAPSCustomerAppBackendMongoDB -d mongo

This command will start a Docker container locally and expose the mongoDB default port 27017.

Start

To start the server, run the following

npm start

The Rest API is now accessible at http://localhost:3000.

Deploy to Heroku

You can also deploy this app to Heroku:

Deploy as a Microservice

You can also deploy the server as a microservice inside a Docker container:

Step 1: Clone the repo

git clone https://github.com/jupiterbak/FAPSDemonstratorCustomerBackend.git
cd FAPSDemonstratorCustomerBackend

Step 2: Build the Docker image

docker build -t fapsdemonstratorcustomerbackend .

Step 3: Run the Docker container locally:

docker run -p 8080:3000 -d fapsdemonstratorcustomerbackend

Step 3_a: Run the Docker container in the cluster:

sudo docker-compose build

docker stack deploy --compose-file swarm_deploy.yml FAPSCustomerAppBackend

Contributing

Any contributions you make are greatly appreciated.

Fork the Project
Create your Feature Branch (git checkout -b feature/AmazingFeature)
Commit your Changes (git commit -m 'Add some AmazingFeature')
Push to the Branch (git push origin feature/AmazingFeature)
Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Jupiter Bakakeu - @JBakakeu - jupiter.bakakeu@gmail.com

Project Link: https://github.com/jupiterbak/FAPSDemonstratorCustomerBackend

jupiterbak/FAPSDemonstratorView2