Giter Club home page Giter Club logo

brightonsbox-serverless-graphql's Introduction

brightonsbox-serverless-graphql

An example of building a serverless GraphQL API using NodeJS and Apollo.

As a time-poor father of a 2 year old I apologise in advance for the succinct nature of this README. This project serves as an introduction for me to implementing a GraphQL server using NodeJS and TypeScript.

The goal is to provide details of my CV via serverless GraphQL API.

I'm using NodeJS version 18.15.0 (Hydrogen LTS). I use NVM for version management locally.

I have decided to leverage the Apollo library to quickly get something working. It is open source (so it doesn't cost me anything), yet is used by many in industry. I'm following their documentation to get started.

At this point, I have spun up a quick working example. To run:

npm install
npm run dev

Then navigate to http://localhost:4000 to reach the Sandbox.

This can also be run using the serverless framework as described here.

To demonstrate it running locally and responding to an example query defined in the example-query.json file, run:

npm run serverless-local

To deploy to your AWS account, run:

export AWS_SECRET_ACCESS_KEY=...
export AWS_ACCESS_KEY_ID=...

with relevant credentials, then run:

npm run serverless-deploy

To remove from your AWS account, run:

npm run serverless-remove

brightonsbox-serverless-graphql's People

Contributors

brightonsbox avatar

Watchers

 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.