Skip to content

README.md

Latest commit

 

History

History
64 lines (40 loc) · 1.97 KB

README.md

File metadata and controls

64 lines (40 loc) · 1.97 KB

Bit Swap

General 💬

Repository of Bit Swap game, created to take part in midyear Flame Game Jam.

Dependencies 🔗

This app is using fvm to manage flutter version.

To install fvm call pub global activate fvm.Then go to project directory and call fvm install and set correct project SDK path. From now on call fvm flutter instead of flutter in terminal commands.

Git setup 📜

workflow

GitFlow Please:

  • work on feature branches
  • create pull requests to develop branch
  • push to main branch to release new version

Branches and commits

Please name branches with feature of bugfix and a brief description. For example: feature/Handle-player-movement.

This repository is using conventional commits to keep commits well organized. Git hooks are used to ensure that the commit message have proper syntax.

Please run following commands from root of this repository to set it up:

git config core.hooksPath .githooks/  # To change default .git hooks directory
chmod ug+x .githooks/commit-msg  # To allow execution in commit-msg file

Example of valid commit message: feat: Handle player movement

Installation ⚙️

Call these command from main directory.

fvm install
fvm flutter pub get

in both of them.

Run 🚀

To run the application call this command or simply debug the app from vscode.

fvm flutter run -t lib/main.dart

Tips 💁

Run those commands from terminal to:

  • sort_imports.sh - automatically sort all imports and format code.
  • intl_utils.sh - regenerate localization files. You should call it after making changes in .arb files.