Flowit-Game / flowit-react

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Flowit-react

A clone of Flowit using typescript / react / nextjs that can be played at https://flowit-game.github.io/flowit-react/

Licensing

Is licenced as AGPL-3.0.

Getting Started

To build flowit-react locally, first, install the node modules:

yarn

Next clone the levels repository

git clone https://github.com/Flowit-Game/Levels.git

Then convert the levels to the expected format

yarn convert-levels

Now you can run the development server:

yarn dev

Open http://localhost:3000 with your browser to see the result.

Building a release

Ensure you have downloaded and converted the levels. Then run

yarn next build
yarn next export

This will create an out directory with static files that can be hosted (e.g. On GitHub pages or Amazon S3) to create the site.

If you have docker available and want a quick preview of the site, you can run

cd out
docker run --rm -p 3001:80 -v $PWD:/usr/share/nginx/html nginx

And then browse to http://localhost:3001

About

License:GNU Affero General Public License v3.0


Languages

Language:TypeScript 56.7%Language:HTML 30.2%Language:CSS 12.8%Language:JavaScript 0.2%