https://wordris.surge.sh

• Team members:
  • Kiarash Zarinmehr
    • phone: 09360922035
    • email: [email protected]
  • Hossein Shabani
    • phone: 09117898569
    • email: [email protected]

Libraries:

• preact-cli v2.1.0

• preact v8.2.9

• mobx v5.0.3

• jest v21.2.1

• full details in package.json file

Installation Guide:

1- You need to install Node and Yarn(NPM has run intor some troubles recently):

Node download

Yarn installation

2- Open your terminal as administrator in project's root directory and enter the command below to install project dependencies It's recommended to use a VPN for installing modules

yarn

3- Make sure that your localhost's port 8080 is not used by any other app and then run the command below to run project Production version on your localhost https://localhost:8080 protocol:

Important Note: If you're using Windows don't use Windows' powershell or command prompt to run this command instead use a bash terminal such as git bash which can be installed from git make sure to check git bash installation

Also for testing on the mobile and use "ADD TO HOME SCREEN" feature and offline usage We have deployed this on Surge here

yarn run serve

and to run Development Version run this command:

yarn start

4- open your browser and navigate to localhost:8080.

5-(optional) You can run tests anytime by the command below

Important Note: If you're using Windows make sure that folder full directory doesn't contain any parens such as C://folder(1)/... otherwise acording to this bug on Jest itself github issue it won't find .test.js files

yarn test

Project info:

• For Better UX we made this project a Progressive Web App(PWA).

• The Production version of this game's Google Lighthouse PWA score is 100 which is perfect.

• This app wasn't large enough so we decided to use Preact instead of React Because It's much lighter(3kb) and has the same API as React.

• We used a compact version of CSS 7-1 pattern to organize CSS files.

• Scores are saved in localStorage and they are avaliable after browser relunch.

• This game has an online multiplayer game mode which makes it more enjoyable to play.