https://github.com/andyfrith/demo-gql
A minimal Node.js TypeScript application providing a GraphQL API
https://github.com/andyfrith/demo-gql
graphql mongodb nodejs typescript
Last synced: about 1 month ago
JSON representation
A minimal Node.js TypeScript application providing a GraphQL API
- Host: GitHub
- URL: https://github.com/andyfrith/demo-gql
- Owner: andyfrith
- Created: 2020-03-24T15:17:12.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-05T17:18:06.000Z (over 3 years ago)
- Last Synced: 2025-02-13T18:46:01.261Z (over 1 year ago)
- Topics: graphql, mongodb, nodejs, typescript
- Language: TypeScript
- Homepage:
- Size: 2.72 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# demo-gql
This demo is a minimal Node.js TypeScript application providing a GraphQL API.
## Table of Contents
1. [Introduction](#introduction)
2. [Features](#features)
3. [Environment](#environment)
4. [Next Steps](#next-steps)
5. [Other Demos](#other-demos)
6. [Contact Developer](#contact-developer)
## Introduction
This very light application serves as a simple demo of several technologies and best-practices.
## Features
Listing all greetings in the database is made possible with the following GraphQL Query:
```ts
{
greetings {
id
message
greeter
}
}
```
Adding a greeting to the database is made possible with the following GraphQL Mutation:
```ts
mutation CreateGreeting {
createGreeting(input: { id: "3", message: "Say hello, to my little friend!", greeter: "Al Pacino"}) {
id
message
greeter
}
}
```
### TyepScript
Why TypeScript? Because, use of types lends itself to using highly-productive development tools and practices; such as, static checking and code refactoring during JavaScript development. Additionally, there is great support for TypeScript in the development community.
### Node.js
The application was built using [Node.js](https://nodejs.org/).
### GraphQL
This application was built using the [Apollo Server](https://www.apollographql.com/docs/apollo-server/) GraphQL server and the Node.js apollo-server-express middleware.
The GraphQL schema is generated using the [GraphQL Code Generator](https://graphql-code-generator.com/).
### MongoDB
A [MongoDB](https://www.mongodb.com/) database is used for storing greetings.
**[⬆ back to top](#table-of-contents)**
## Environment
### Available Scripts
In the project directory, you can run:
#### `npm install`
Installs the necessary modules required to build and run the application.
#### `npm generate`
Generates GraphQL schema by running the the [GraphQL Code Generator](https://graphql-code-generator.com/).
#### `npm start`
Stards the Node.js process, runs the app.
Open [http://localhost:5002/graphql](http://localhost:5002/graphql) to view the GraphQL playground in the browser.
#### `npm run build`
Compiles the typescript using tsc, building the app for production.
#### `npm run test`
Tests will be added in the future.
**[⬆ back to top](#table-of-contents)**
## Next Steps
* Authentication
* Server-side Batching & Caching
**[⬆ back to top](#table-of-contents)**
## Other Demos
[demo-gql-ui](https://github.com/andyfrith/demo-gql-ui) - the UI counterpart- a minimal React Typescript application providing a simple UI that acesses the GraphQL API endpoints of the demo-gql server
[react-portal](https://github.com/andyfrith/react-portal) - a React Redux application that provides simple user management tasks upon successful JWT authentication
[greasy-spoon-pos](https://github.com/andyfrith/greasy-spoon-pos) - a React Redux application that provides minimal features of a very basic restaurant Point of Sale system
[goodapplemedia.com](https://github.com/andyfrith/goodapplemedia.com) - a responsive website created with HTML5, Foundation CSS, and ES6 that demonstrates an exceptional and desirable user experience
**[⬆ back to top](#table-of-contents)**
## Contact Developer
I'm driven to deliver exemplary User Experiences and sound application architectures. I enjoy solving customer problems with excellent design and engineering- to greatly affect business success.
[Portfolio](http://goodapplemedia.com)
[Email: afrith.denver.usa@gmail.com](mailto:afrith.denver.gmail.com)
[LinkedIn](https://www.linkedin.com/in/goodapplemedia/)