Skip to content

petr166/foosball-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

45 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

foosball-api - GraphQL API for Foosball App

NodeJS backend serving data from MongoDB through a GraphQL layer, k!boom
^for feature set and more check the app repo

Prerequisites

  • NodeJS with npm
  • MongoDB instance (either local or remote)

Run server

  • create a .env file using the format from .env.example, with your options
    • especially important, set the db credentials
  • run npm run dev
  • access the api at http://localhost:4000 by default

Technologies

these are the main technologies and/or modules used, for all libraries check package.json

  • NodeJS - JavaScript backend/server-side solution of choice

    • Typescript - superset of Javascript, adding types and more
  • MongoDB - data storage solution that just speaks JSON and pairs very well with Node

    • Mongoose - package that helps with object modeling and manages connection between server and database

    • Bcrypt - for hashing user passwords to be stored in the database

  • GraphQL - api query language, for efficient app-server data exchange

    • Apollo Server - full graphQL server implementation, to handle queries, mutations, resolvers etc.

    • JSON Web Token - generate JWTs for secure authentication