ted-marozzi / alg-io

A data structure and algorithm viewing tool. Written in flutter deployed in ios, android and web.

alg-io

A data structure and algorithm viewing tool. Written in flutter deployed in ios, android and web.

Project Goals / Design

The Goals of the project are to:

1. Create a useful data visualisation tool for students interested in Computer Science,

2. Build the foundations of knowledge in App Development for all team members,

3. Develop an in depth understanding of Flutter and Dart as a coding base, and

4. Apply best Git workflow practices as part of a team project environment.

Workflow and Design Pattern

Please follow this style guide. https://dart.dev/guides/language/effective-dart/style

Our GitHub workflow is planned to be as follows:

To begin:

git clone https://github.com/ted-marozzi/algo-io.git

# Make sure you are in the repo folder
cd algo-io

# This pulls/copies the origin (Or remote master branch) to master 
# (or local master)
# and ensures the local master and origin master are in sync
git pull origin master

# This creates and moves onto a new feature branch
git checkout -b username-feature

To use:

# This pulls/copies the origin (Or remote master branch) to master 
# (or local master)
# and ensures the local master and origin master are in sync
git pull origin master

# This moves onto the feature branch you are working on
git checkout username-feature

# Make add and commit your changes with descriptive messages, 
# when feature is done.
git add .
git commit -m "Descriptive"
git push origin username-feature

# Now wait for pull request to be reviewed and accepted or denied.
# If accepted make sure to, and just do it in general to stay up to date
git pull origin master

Other useful commands:

# delete branch locally
git branch -d localBranchName

# delete branch remotely
git push origin --delete remoteBranchName