Giter VIP home page Giter VIP logo

backend-project-nc-games's Introduction

Northcoders House of Games API

Link to the backend project

Background:

The project is an API that allows for programmatic access to application data (game reviews). The API is designed to mimic a real-world backend service, such as Reddit, and will provide data to the front-end architecture. The database used in this project is PostgreSQL and it will be interacted with using the node-postgres library.

API endpoints:

To get a list of all endpoints: GET: /api

How to use:

Git clone:

run the following into a directory of your choice in the terminal:
git clone https://github.com/H3nry-T/backend-project-nc-games.git

Dependencies:

Install dependencies in the terminal using the following:
npm install

Here is what you should have in the package.json file in the root:

    "dependencies": {
        "dotenv": "^16.0.0",
        "express": "^4.18.2",
        "pg": "^8.7.3",
        "supertest": "^6.3.3"
    },
    "devDependencies": {
        "husky": "^8.0.2",
        "jest": "^27.5.1",
        "jest-extended": "^2.0.0",
        "pg-format": "^1.0.4"
    },

Environment:

  1. make a dotenv file called .env.test
  2. Setup your dotenv file to include the following: PGDATABASE=nc_games_test
  3. make a dotenv file called .env.development
  4. Setup your dotenv file to include the following: PGDATABASE=nc_games

Seeding the database:

npm run setup-dbs
npm run seed

Testing:

npm run test

Minimum versions:

Node.js: v18.12.1
Postgres: v15.1

backend-project-nc-games's People

Contributors

h3nry-t avatar anthonymedina avatar nc-paul-rogerson avatar p-copley avatar dav3rid avatar daviidbartlett avatar bainesface avatar anatdean avatar rogersop avatar alexander-cox avatar sssam-c avatar tomosim avatar augs0 avatar douglashellowell avatar itskatherine avatar liam310 avatar xmenbteam avatar antariess avatar elijaharley avatar isabelmaccabee avatar nicola-20 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.