Game Deals API

REST API

About the project   |    Technologies   |    Getting started   |    How to contribute   |    License

👨🏻‍💻 About the project

• A REST API that serves most of the deals and discounts on PC games for Game Deals App

• It serves the discounts in famous stores like:-
  • Steam
  • Origin
  • Epic Games
  • GOG

🚀 Technologies

Technologies that I used to develop this REST API

• Node JS v16
• Typescript v4
• Express v4
• Nest JS
• Axios
• Rx JS
• Cheerio
• Cache Manager

💻 Getting started

Requirements

• Make sure nodejs is installed, you could check using this command

$ node --version
# v16.16.0

Installation

Using npm

$ npm install

Using yarn

$ yarn install

Running the app

Using npm

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

Using yarn

# development
$ yarn run start

# watch mode
$ yarn run start:dev

# production mode
$ yarn run start:prod

Deploying to Vercel

Vercel detects src/main.ts as the NestJS entry point and deploys the API as a Node.js function. Import the repository into Vercel and deploy it with the default build settings; no output directory or route rewrites are required.

The deployment uses Node.js 22. Use GET /health as a deployment health check.

APP_URL is optional on Vercel because generated image links use the automatic VERCEL_URL. Set APP_URL in the Vercel project environment only when links should always use a custom domain, for example https://api.example.com.

🤔 How to contribute

Make a fork of this repository

# Fork using GitHub official command line
# If you don't have the GitHub CLI, use the web site to do that.

$ gh repo fork MohamedAmgd/Game-Deals-API

Follow the steps below

# Clone your fork
$ git clone your-fork-url && cd Game-Deals-API

# Create a branch with your feature
$ git checkout -b my-feature

# Make the commit with your changes
$ git commit -m 'feat: My new feature'

# Send the code to your remote branch
$ git push origin my-feature

After your pull request is merged, you can delete your branch

📝 License

This project is licensed under the GPLv3 License - see the LICENSE file for details.

---

Made by Mohamed Amgd 👋 See my linkedin