JavaScript HTML CSS
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.
config
db
public
routes
views
.gitignore
README.md
app.js
game-sockets.js
package.json
run-dev

README.md

pathfinder

A turn-based game that allows two players to build mazes for each other that each must go through blind. First player to find the exit wins.

Play with your friends here

Note: The game is still in development, and will have some kinks in it, feel free to report them via Issues.

To Start

To run the server on your local machine, first start the database. If you installed mongodb correctly, you should be able to run mongod

This will start the mongo server and you will need to leave it open, open up another terminal, navigate to the project folder and run the following to run the application: node app.js

Installation

To run this on our local machine, we will need the following:

First, make sure your git is properly installed, and you have your ssh key configured for your machine. For help on this, go to the Github help page That's also a good resource to figure out the git commands.

To download this repo on to your machine, open your terminal, cd to where you want to place this project, and enter:

git clone git@github.com:SCastaneda/pathfinder.git

Node can be downloaded from its offical website. Install node for your OS. Along with the installation of node, comes npm, which is node's package manager.

We will be using npm to manage our modules.

Mongodb will serve as our database. Download and follow the Install and Getting started section

The Express module will be used as a layer on top of nodejs to make the process of creating and managing pages easier, it comes with several built in functionalities, such as session handling and more. Read more about Express

Once you have node, npm, and mongodb installed, to install all other modules that are required for the project (defined in package.json) you can just run npm install in the terminal. If you get an EACCESS error, try runnning it with sudo npm install to run it as the superuser (password entry will be required). I'm not sure if there's an equivalent for windows.