Skip to content

README.md

Latest commit

 

History

History
45 lines (36 loc) · 1.41 KB

README.md

File metadata and controls

45 lines (36 loc) · 1.41 KB
Raw

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 fetch the levels repository, which is a submodule in levels-source (or clone with --recurse-submodules)

git submodule update --init

Now you can run the development server:

yarn dev

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

Building a release

Ensure the levels-source submodule is checked out (git submodule update --init). Then run

yarn next build

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. Run yarn start for a quick preview.

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

Updating the levels

The levels are pinned to a commit of the submodule. To pull in new levels, run

git submodule update --remote levels-source

and commit the updated levels-source.