Giter VIP home page Giter VIP logo

hogwarts-api's Introduction

Hogwarts

Hogwarts API

Small project to show how GraphQL works using as example Hogwarts.

The project uses the House-Student relation to show how easy becomes to join different MongoDB collections from the client thanks to GraphQL.

It also provides a mutation to add or substract points to a specific house, to make Hogwarts teacher's lifes easier.

Steps

  • Create a .env file with the content described in the section below, adding the correct PORT and DDBB connection string.
  • Execute the seed by running the command yarn db:seed.
  • Start the project with either yarn start or yarn dev.
  • Go to http://locahost:${PORT}/graphql to view GraphiQL and be able to execute your queries.

.env file

Find below the .env file sample:

PORT=
DATABASE_URL=

The information in the fields is the following:

  • PORT: Port that will be used to run the project locally.
  • DATABASE_URL: Connection string to allow use an external database, either from local or in the Cloud.

Scripts

The project contains three scripts to make its usage easier:

  • db:seed: Inserts some default data in the database to start playing around with data. You can update the information by changing the content that you will find in data/seed.js.
  • dev: Will run nodemon to start the project in a DEV environment, auto-reloading the server with every change you do.
  • start: Will execute the project in a PROD environment.

Technologies

  • Node.js
  • Express
  • GraphQL
  • MongoDB
  • Mongoose
  • Yarn

hogwarts-api's People

Contributors

lluisarevalo 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.