Skip to content

GraphQL dockerized - A GraphQL sample project developed for it-economics Conference Day 2017

Notifications You must be signed in to change notification settings

dlorian/graphql

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

GraphQL dockerized - A GraphQL sample project

This project should demonstrate how to work with Facebook's query language for APIs: GraphQL.

GraphQL is a query language for your API. This project runs a simple GraphQL endpoint providing an API to fetch mocked blog data. You can query e.g for posts with their authors or users and their followers. You can also create new users and add new posts. This project should just demonstrate the handling of GraphQL.

The app is running as a Node.js application within a Docker container assembled with docker-compose. As a database it uses MongoDB.

Getting Started

Just go to ypur project root, run npm install to download all dependencies and the hit npm run app:start.

cd $(project-root)/graphql
npm install
npm run app:start

This will automatically start the application within a Docker container. If you run it the first time it may take a while.

When the application has started successfully, go to http://localhost:3000/graphql in your favorite browser. This will open up the GraphiQL client where you can discover the provided API.

npm run app:stop

This will stop the application again and all its dependent Docker containers.

Prerequisites

Before you can use this project make sure that you fulfill the following prerequisites. In order to run the application the following must be installed on your machine:

Node.js & NPM

Make sure you have installed Node.js and NPM installed on your local machine. If you need to install it, have a look at https://nodejs.org/en/. Node.js comes together with NPM.

Docker

In order to run the the dockerized application you need to install Docker. If you want to install it may visit Docker docs.

Build & Run

npm run app:start

Use this command to build and run the app at once. At first it will build the application and run it afterwards within a Docker container.

npm run app:stop

With this you can shutdown all containers again.

Build app alone

npm run build

If you just want to build the app, run npm run build in the root directory to build the application. After that, the dist folder contains all required assets to start the app.

Run app alone

npm start

If you want to run the app alone, without running it in a Docker container just type npm start. But make sure that a MongoDB instance is up and running (localhost:27017).

Run Docker containers

npm run docker:up

If you want to run the application within a Docker container run npm run docker:up. You could also just type docker-compose up within the base directory to start the application and its database container.

Stop Docker containers

npm run docker:down

This command will shutdown the GraphQL container an all its dependend database containers again. If all containers has stopped successfully you can see with docker ps.

About

GraphQL dockerized - A GraphQL sample project developed for it-economics Conference Day 2017

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published