README.md

vg-api

Intro

Coming soon

Requirements

This project requires the following:

• Node.js

Workstation setup

Clone the repo to your machine. Then run:

npm i

Reach out and request the .env file. To use your own credentials, follow the setup for games/news:

• IGDB.
• RapidAPI.

Running the project

Start the server with

npm run start

Your server should be running at http://localhost:3001/

Insomnia/Postman

There is a file called Insomnia.json in the root folder. Import into the API client of your choosing. 3 Environments are setup: localhost, development, and prod.

Deployments

This project is deployed to railway. Use the following URLs to access the API:

• Development
• Production

Jetbrains prettier setup

To add prettier to your webstorm IDE, Reference the docs at prettier.