flowser

module
v2.0.3-beta.0...-64157fd Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 11, 2022 License: MIT

README

Flowser banner

News: Our app is currently in beta and we'd love to hear your feedback! Follow us on Twitter or join our Discord server for updates and feedback.

Flowser is first-of-its-kind development tool for Flow blockchain. It does the heavy work of managing blockchain emulator, inspecting the current state, interacting with the network and much more!

Key Features

  • Easy to use: Simplifies your development workflow
  • Transparent development: See the whole state of your local Flow blockchain in real-time
  • Snapshot management: Create and checkout blockchain state snapshots - similar to how Git works
  • Development wallet: Built in fcl-dev-wallet integration for easy blockchain interactions
  • Account storage inspection: Visual account storage inspection

Get started

To get started, just download the app for your platform using the links below!

Download on Windows Download on MacOS

If you encounter any issues with the app, open a new Github issue or reach to us on Discord!

Development

1. Clone flowser repository

git clone https://github.com/onflowser/flowser

2. Install dependencies

The following system dependencies are required:

  • Node.js (tested on v14.19)
  • Yarn (tested on v1.22)
  • TypeScript compiler - tsc (tested on v4.7.4)
  • Protocol Buffers compiler - protoc (tested on v3.21)
  • flow-cli

If you're using nvm for Node.js version management, then just run nvm use in project root.

After prerequisites are installed, you can run the following command to set up local environment:

yarn run bootstrap

It's recommended that you don't use your global installation of @nestjs/cli, because that can cause some unexpected issues.

3. Start Flowser

As website

This is the recommended way for quick prototyping purposes, because it's faster.

Note that if you use this command, the app won't be run in the Electron environment, so it's always recommended to also test it with as a desktop app too.

yarn run start
As desktop app
yarn run start:desktop

License

Flowser is MIT licensed.

Directories

Path Synopsis
pkg

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL