-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
35 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,38 @@ | ||
# IncoHangman | ||
|
||
TODO: Write a project description | ||
Play a classical Hangman game on Inco - a privacy focused blockchain with fully homomorphic encryption and on-chain randomness. Rules are simple: guess a 4 letter word one letter at a time before the picture completes after 11 wrong guesses. | ||
|
||
Written with React + Svelte. | ||
Written with React + Svelte. | ||
|
||
|
||
# Dependencies | ||
The project uses the following dependencies: | ||
|
||
- @privy-io/react-auth for the Privy overlay | ||
- @twa-dev/sdk for Telegram Web API | ||
|
||
# How it works | ||
The game is written using two frameworks: | ||
- React for the Privy overlay. | ||
- Svelte for the game UI. | ||
|
||
App.tsx is managing state, using Privy hooks, connects to Inco and sends transactions, makes calls to faucet, etc. | ||
Game.svelte is rendering the game graphics and animations. | ||
|
||
# How to run locally | ||
To run the project locally, run the following commands: | ||
```bash | ||
npm install | ||
npm start | ||
``` | ||
|
||
# How to deploy | ||
This project is deployed on GitHub Pages. To deploy, install github CLI | ||
```bash | ||
npm install -g gh | ||
``` | ||
Then run | ||
|
||
```bash | ||
npm run deploy | ||
``` |