Need 4 Screech

A Newfoundland-inspired 2D Platformer Game built using JavaScript, HTML/CSS, Node.js and MongoDB.

Getting Started

Make sure you have node and npm installed

1. Clone this repository
2. cd Need-4-Screech
3. npm install
4. cp config-template.json config.json
5. Set up your database (see the following subsection)
6. npm run build to bundle up the frontend
7. npm run start to run the server
8. Go to localhost:3000

Setting up your Database

Primarily, you will need to have MongoDB installed on your machine, for your specific operating system. If you do have the MongoDB server installed on your machine already, you can skip ahead to the steps below; otherwise, please see Installing MongoDB on Ubuntu and follow the steps up until the "Run MongoDB Community Edition" section.

1. sudo service mongod start to start the mongodb daemon server
2. With your current working directory at the root of this repository, run mongorestore --db need-for-screech ./db-snapshot to populate your local database.

If you are having an issue running step 2 due to mongodb permissions, try the following:

1. Open /etc/mongod.conf with your preferred text editor

2. Disable authorization by ensuring the following is included in the configuration file:

   security:
       authorization: "disabled"
   

Authors

Alaa, Liam, Moustafa, Vineel, Riley