webpack-graphql-server - GitLite

KO | EN

gitlite — search

#hacktoberfest #react #typescript #llm #go #golang #machine-learning #linux #docker #java #windows #awesome #cli #ios

webpack-graphql-server

(★ 161)

Starter kit for apollo server using webpack and typescript

File Explorer

Download Latest Version (.zip)

- - schema.spec.ts.snap
- - person-database.ts
- - index.ts
- main.spec.ts
- main.ts
- schema.spec.ts
.dockerignore
.editorconfig
.gitignore
.npmignore
.travis.yml
CHANGELOG.md
Dockerfile
LICENSE
package.json
README.md
tsconfig.json
tslint.json
webpack.config.js
yarn.lock

# Installation Guide

1. Get the code

git clone https://github.com/DxCx/webpack-graphql-server

Downloads the entire project code from GitHub to your computer.

cd webpack-graphql-server

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Docker Desktop Needed to build and run containers. Install it and keep it running in the background.

docker build -t webpack-graphql-server .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 webpack-graphql-server

Runs the built image as an actual container.

✅ Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

3. Node.js

Easy

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

npm start

Starts the development/run server.

npm run build - build the library files (Required for start:watch)

Builds optimized production files.

npm run build:watch - build the library files in watchmode (Useful for development)

Builds optimized production files.

npm start - Start the server

Starts the development/run server.

npm run start:watch - Start the server in watchmode (Useful for development)

Starts the development/run server.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# webpack-graphql-server

[![npm version](https://badge.fury.io/js/webpack-graphql-server.svg)](https://badge.fury.io/js/webpack-graphql-server) [![Build Status](https://travis-ci.org/DxCx/webpack-graphql-server.svg?branch=master)](https://travis-ci.org/DxCx/webpack-graphql-server) [![Coverage Status](https://coveralls.io/repos/github/DxCx/webpack-graphql-server/badge.svg?branch=master)](https://coveralls.io/github/DxCx/webpack-graphql-server?branch=master)

Starter kit for apollo graphql server using webpack and typescript

What does it include:
----
    1. exported schema as example for GraphQL Schema
    2. Working Apollo Server (webpack + tslint + tsloader)
    3. Typescript 2.4.2 => ES6
    4. Dockerfile to make the graphql-server a container.
    5. unit testing (jest) + coverage report (jest --coverage).
    6. working with graphql-tools
    7. standard-version for auto SemVer.

Notes
----
Please note that you will need to rename the library name in some files:

1. package.json (ofcourse ;))

Useful commands:
----
    npm run build       - build the library files (Required for start:watch)
    npm run build:watch - build the library files in watchmode (Useful for development)
    npm start           - Start the server
    npm run start:watch - Start the server in watchmode (Useful for development)
    npm test            - run tests once
    npm run test:watch  - run tests in watchmode (Useful for development)
    npm run test:growl  - run tests in watchmode with growl notification (even more useful for development)
    npm run upver       - runs standard-version to update the server version.

How to run it:
----
```bash
    npm start
```

Files explained:
----
    1. src                         - directory is used for typescript code that is part of the project
        1a. main.ts                - Main server file. (Starting Apollo server)
        1b. main.spec.ts           - Tests file for main
        1c. schema                 - Module used to build schema
            - index.ts             - simple logic to merge all modules into a schema using graphql-tools
            - modules/             - directory for modules to be used with graphql-tools
        1c. schema.spec.ts         - Basic test for schema.
        1c. main.test.ts           - Main for tests runner.
    3. package.json                - file is used to describe the library
    4. tsconfig.json               - configuration file for the library compilation
    6. tslint.json                 - configuration file for the linter
    7. typings.json                - typings needed for the server
    8. webpack.config.js           - configuration file of the compilation automation process for the library
    9. webpack.config.test.js      - configuration file of the compilation when testing
    10. Dockerfile                 - Dockerfile used to describe how to make a container out of apollo server
    11. mocha-webpack.opts         - Options file for mocha-webpack

Output files explained:
----
    1. node_modules - directory npm creates with all the dependencies of the module (result of npm install)
    2. dist         - directory contains the compiled server (javascript)
    3. html-report  - output of npm test, code coverage html report.

The Person type - dynamic/parametrized query and drill down:
----
The person type was added to demonstrate a database like access, parametrized queries, resolvers and drill down.
The data is currently hard coded but simulates a storage. Each person has an id, name and sex. It also has a dynamic
field called matches. For demonstration purposes, this field will retrieve all members of the other sex by using a
resolver.

Since this is a computed field the query can be infinitely nested, for example, try in the graphiql editor this query:

{
       getPerson(id: "1") {
         id,
         name
         sex
         matches {
           id
           name
           sex
           matches {
             id
             name
             sex
             matches {
               id
               name
               sex
             }
           }
         }
       }
     }

It will return a nested, alternating male/femal results.

To list all persons, use the `persons` query:

{
      persons {
        id
        name
      }
    }

There is also an example of a mutation - `addPerson(name: String, sex: String)`, to use it:

mutation {
        addPerson(name: "kuku", sex: "male"){
            id
            name
        }
    }

Note that the query generates a random id and that the added persons are transient,
i.e. not persisted and will be gone once you shut down the server.

Sample clients for this server:
----
* [ionic2](https://github.com/philipbrack/ionic2-apollo-simple)