Isopath is an abstract board game invented by pocket83. For more information about the game itself, it is highly recomended to watch his videos concerning the game. This project is an effort to make an open source Isopath server (taking a huge amount of inspiration from lichess).
Running the project will require NodeJS
- Download the project
- Run npm init
- Add .env file and needed variables
- PORT: the port that express will listen on
- MONGO_HOST: address for mongo client
- MONGO_PORT: port for mongo client
- TOKEN_SECRET: Secret used to create and verify JWTs
- Run npm start
The primary intention of this project is to allow people to create clients for IsoPath, documentation will be added as the API becomes functional and more robust. One could also use this code base to run their own IsoPath server.
The primary goal at this point is to make the API robust enough to allow for user creation, game challenges, and basic game-play.
We would love for you to contribute. Small contributions are extrememly welcome this could include documentation of the code, API, or README; filing issues or finding bugs; fixing self contained bugs. All of these contributions are small but by no means insignificant to the success of the project. At this point the project is extremely volitile and in flux and as such may be difficult for contributions without significant collaboration with the IsoPath team (just parkerbjur right now). Please email parkerbjur at bjur.parker45@gmail.com if you are interested in contributing.
- Helping in the development in any way you can
- Interacting with the repo (Star, Fork, Watch)
- Let us know you're excited about the project bjur.parker45@gmail.com