UNC Coding Bootcamp Project #3

The aMeizing Rejects

Project 3 for UNC Coding Bootcamp
Explore the Documentation »

Table of Contents

• Table of Contents
• About The Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Contributing
• License
• Contact

About The Project

For our team project #3 we created a website that allows the user to view and search video game information, sort by recent titles that are popular as well as see upcoming titles that will be released within a given parameter.

Here's why:

• No wide spread resource for finding new games based on user-reported input
• Other websites push sponsered content to front page
• Popular resources often have a cluttered UI which can confuse users
• Lack of personalized content delivery for gamers
• People over-look small developer based titles from lack of exposure

Built With

• Bootstrap

• JQuery

• React

• Node

• Express

• MongoDB

Getting Started

Follow these basic steps to run this app on your local machine.

Prerequisites

Here is a list of packages and libraries necessary to run this app on a local machine.

• npm

npm install npm@latest -g

must npm install inside root directory as well as frontend directory

• MongoDB

npm install mongodb

Installation

1. Get a free API Key at https://api.igdb.com
2. Clone the repo

git clone https:://github.com/your_username_/Project-Name.git

3. Install NPM packages

npm install

4. Start Local Servers

from main directory

- npm run client

from sub-directories

- Backend: node server.js
- Frontend: yarn start

5. Enter your API in config.js

const API_KEY = 'ENTER YOUR API';

Usage

PLACEHOLDER

For more examples, please refer to the Documentation

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature)
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Team UnAmeiezed - Who's Ameizing - [email protected]

Project Link: https://github.com/TylerCEdge/project-3