Skip to content

Latest commit

 

History

History
89 lines (51 loc) · 2.45 KB

README.md

File metadata and controls

89 lines (51 loc) · 2.45 KB

Super Nintendo Game Info

Searchable information on every official North American SNES game release. View a synopsis from Wikipedia and videos from YouTube all in one place!

Check it out in action. *Please give it a second, free hosting

These instructions don't work anymore! - Keeping for posterity

Installation

You’ll need to have Node >= 6 on your machine.

From the location where you want to install the app:

git clone https://github.com/ianrosedev/Super-Nintendo-Game-Info.git

Then from the root directory:

npm run install-all

The app and all dependencies will now be installed.

You need to get a YouTube API key!

The Google Developers documentation will guide you through the process. You will need a 'simple API key'. After obtaining a key, copy it and place it in server/helpers/keys.js.

The app is now ready to go!

Starting the App

From the root directory:

npm run start-dev

This will start both the frontend and API servers concurrently. If Chrome is available, the app will open automatically.

The app is now running at: http://localhost:3000

If you need access to the API server, it is running at: http://localhost:3001

Testing

Client:

From the client directory:

Test the whole app:

npm test

Test an individual component:

npm test -- [ComponentToTest].test.js

Server:

There are currently no tests for the server.

Build

The client side is built with React using the Facebook create-react-app. More documentation will be found at the GitHub page.

From the client directory:

npm run build

A production ready build folder will be produced.

Usage

When you load the app you will be at the landing page. From there you can check out the specially chosen 'Featured Game' or scroll down to the 'Full Game Listing'. The list is searchable and contains all of the North American SNES game releases plus a few more.

After browsing the list or searching for a game, you can click on a link to a page specifically for that game. In this page you will find an excerpt of the games Wikipedia page and three YouTube videos showing gameplay.

If you return to the landing page after a search, your search will be saved. This will enable you to check out games in a specific series one after another.

Have fun!