No description, website, or topics provided.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
public
src
.firebaserc
.gitignore
README.md
firebase.json
package-lock.json
package.json

README.md

CreditWise

CreditWise is an educational Progressive Web App game that was created in a group of six for the final project for the Northcoders coding bootcamp, completed July 2018. It consists of a game as well as an admin site where game statistics can be seen.

The game is intended to introduce financial responsibility to Key Stage 2 primary school children. It provides real time and retrospective statistics to the admin user and is also available offline. It was built with Node.js, React.js, Redux and Firebase

Getting Started - local

These instructions will help you get a local version running.

Please clone the repo from: https://github.com/bnmrly/project-game-FE

Run npm install in the command line to get the required dependencies.

npm install

You will need to create a Firebase account in order to play the game locally. To do this, you need to create a config.js file in the firebase folder. Please visit https://firebase.google.com/docs/ for info on how to create an account then replace the info below with your credentials.

import firebase from ‘firebase’;
import ‘firebase/firestore’;

const config = {
 apiKey: `${YOUR-API-KEY}`,
 databaseURL: `https://${URL-TO-YOUR-DATABASE}.firebaseio.com`,
 projectId: ‘${YOUR-PROJECT-NAME}’
};

firebase.initializeApp(config);

export const db = firebase.firestore();

To launch the development server, run the start script

npm start

This will open the app in your browser at this address:

localhost:3000/

Please enter the following id and create a username to play the game locally:

AwDa6TG6l1LtyemAENz0

The admin code can repo also be viewed here https://github.com/hannahbennett27/project-admin-FE

Getting Started - live

Please visit the admin site at https://creditwise-admin.firebaseapp.com/ to create an account. When you sign in, you are given an account id.

You can then visit the game at: https://creditwise-game.firebaseapp.com/ and input this id and your name.

Authors

Hannah Bennett: https://github.com/hannahbennett27

Luke Birkett: https://github.com/luke101308

Renaldus Jakas: https://github.com/Justadudewhocodes

Brad Lockhart: https://github.com/BradLockhart

Ben Marley: https://github.com/bnmrly

Patrick Walsh: https://github.com/tricky93

Acknowledgments

Thanks to team CreditWise.