Skip to content

Latest commit

 

History

History
100 lines (86 loc) · 4.83 KB

README.md

File metadata and controls

100 lines (86 loc) · 4.83 KB

Wiki Adventure

join me on Discord number of people onlines on the game Link Monitoring State

Wiki Adventure is a multiplayer game combining culture and speed. Players compete against each other on Wikipedia and have to scroll through the pages as quickly as possible to win.

PlayTech stackContributingDiagramRun the project

🚀 Tech stack

Haxe logo Node js logo Quasar js logo Vue js logo Typescript logo

The project is Web app made out of a backend and a frontend:

  • The backend is written in Haxe which compile to javascript that will be interpreted by Node js.
  • The frontend is written in Quasar 2 based on Vue 3 with typescript

🖋️ Contributing

Want to help with Wiki Adventure? Well first, Thank you so much for your interest! We are always appreciate for improvements to the project and contributions from open-source developers are greatly appreciated. What you can do to help:

  • Make the game available in your language, check this guide (WIP).
  • Create you own game mode, check this guide (WIP).
  • Solve one of those issue (if there no issue we've made a great job!).
  • Make a code review. It always good to have a second eye!
  • Donate on Ko-Fi ❤️

📋 Diagram

Check out the backend diagram ( still in progress )

Frontend diagram soon!

Run the project

Node js

  • Make sure you have v14 or higher. You can install it from the official website here.

Librairies

  • Install all the required librairies for the backend and frontend in one click with the setup.sh script.
echo "Install global lib"
npm i -g lix; npm i -g nodemon; npm i -g @quasar/cli
echo "Install local lib"
cd back; npm i; cd ../bin; npm i; cd ../front; npm i

Workspace

  • If you use Visual Studio Code (I recommend it ❤️) you can open the project with the project.code-workspace file.

Debug

Run a private instance

npm run build; npm run start