https://github.com/hckhanh/games-searcher
A search tool for gamers who love best prices
https://github.com/hckhanh/games-searcher
best demo example games node nodejs price-comparison price-tracker pricelist prices react reactjs redux search searcher steam steam-api tool
Last synced: 6 months ago
JSON representation
A search tool for gamers who love best prices
- Host: GitHub
- URL: https://github.com/hckhanh/games-searcher
- Owner: hckhanh
- License: mit
- Created: 2017-02-12T06:42:05.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2022-12-10T20:28:16.000Z (over 2 years ago)
- Last Synced: 2024-04-14T17:46:14.961Z (about 1 year ago)
- Topics: best, demo, example, games, node, nodejs, price-comparison, price-tracker, pricelist, prices, react, reactjs, redux, search, searcher, steam, steam-api, tool
- Language: JavaScript
- Homepage: https://games-searcher.herokuapp.com/
- Size: 4.02 MB
- Stars: 7
- Watchers: 2
- Forks: 4
- Open Issues: 71
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Project Title
[](https://travis-ci.org/hckhanh/games-searcher)
[](https://www.paypal.me/hckhanh/5)
A search tool for gamers who love best prices
## Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
See deployment for notes on how to deploy the project on a live system.
### Prerequisites
* [Node.js](https://nodejs.org/en/) 7.7.1 or above
* [isthereanydeal.com](https://isthereanydeal.com/) api
* [openexchangerates.org](https://openexchangerates.org/) api
### Installing
1. Clone the project
1. You will need to setup **environment variables**. Some API keys are **confidential**, you need to get them by yourself
| Variable | Description |
|:---------------:|--------------------------------------------------------------------------------|
| ITAD_API_KEY | [isthereanydeal.com](https://isthereanydeal.com/) |
| FACEBOOK_APP_ID | Additional, I use Facebook service to use some plugins to share and track data |
| OER_APP_ID | [openexchangerates.org](https://openexchangerates.org/) |
| APP_URL | http://localhost:3000 |
| APP_TITLE | Games Searcher |
| APP_DESCRIPTION | A search tool for gamers who love best prices |
| APP_IMAGE | http://localhost:3000/cover.png |
### Run the project in development mode
```bash
npm i
npm run dev
```
## Running the tests
```bash
npm test
```
> For now, I just cover the testing for API of the application on the server side
## Build
Simply run
```bash
npm run build
```
But you will need to setup these environment variables for production:
| Variable | Description |
|:-----------------:|---------------------------------------------------|
| APP_TITLE | Games Searcher |
## Deployment
Currently, I am using Heroku to deploy the production app. You need to change these environment variables in production stage
| Variable | Description |
|:---------------:|----------------------------------------------------------------|
| ITAD_API_KEY | [isthereanydeal.com](https://isthereanydeal.com/) |
| OER_APP_ID | [openexchangerates.org](https://openexchangerates.org/) |
| FACEBOOK_APP_ID | Use the production app id of Facebook API |
| APP_TITLE | Games Searcher |
| APP_URL | The root url of the application |
| APP_DESCRIPTION | A search tool for gamers who love best prices |
| APP_IMAGE | The url of the cover image when user share the app to Facebook |
I am using [Rollbar](https://rollbar.com/) service to track error from both front-end and backend sides.
So there are additional apis need to be set:
| Variable | Description |
|:--------------------:|--------------------------------------------------|
| ROLLBAR_CLIENT_TOKEN | Your server-side access token |
| ROLLBAR_SERVER_TOKEN | Your client-side access token for games-searcher |
## Built With
* [Webpack 2](https://webpack.js.org/) - The assets bundle tool
## Versioning
I use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/hckhanh/games-searcher/tags).
## Author
* **Khanh Hoang** - *Initial work* - [hckhanh](https://github.com/hckhanh)
## Sponsor
## License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details