Setting up the development environment

Make sure you have the following dependencies available:

• Linux, Mac OS X, or Windows.

• git (used for source version control).

• Flutter SDK with the branch dev or master.

• An IDE. Android Studio with the Flutter plugin is our flagship IDE. You can use whatever IDE you feel most comfortable with.

• An ssh client (used to authenticate with GitHub).

• The Android platform tools.

  You can install this using one of the following commands:

  • Mac: brew cask install android-platform-tools
  • Linux: sudo apt-get install android-tools-adb

Run the following steps to set up your environment:

1. Ensure that adb (from the Android platform tools) is in your path (e.g., that which adb prints sensible output).

2. Fork https://github.com/Darkness4/minitel-app/tree/develop into your own GitHub account. If you already have a fork, and are now installing a development environment on a new machine, make sure you've updated your fork so that you don't use stale configuration options from long ago.

3. If you haven't configured your machine with an SSH key that's known to github then follow the directions here: https://help.github.com/articles/generating-ssh-keys/.

4. git clone git@github.com:<your_name_here>/minitel-app.git

5. cd minitel-app

6. git remote add upstream git@github.com:Darkness4/minitel-app.git (So that you fetch from the master repository, not your clone, when running git fetch et al.)

7. git fetch upstream Fetch it now

8. git checkout upstream/develop -b <name_of_your_branch> Create your own branch named after your patch.

9. Run flutter packages get This will fetch all the packages that Minitel Toolbox depends on.

10. Hack away

• Style guide for Flutter repo, to learn how to write code for Flutter.
• Tree hygiene, to learn about how to submit patches.

12. git commit -a -m "<Theme>: <your informative commit message>" (eg.: "Gateway: Deleted")

13. Send us a pull request:

• Go to https://github.com/Darkness4/minitel-app/tree/develop and click the "Compare & pull request" button. (only the code owner has the right to push to master)