Deskify

📑 About the project

An app to manage your desk, and your work. The project is related to a desk project of mine and is getting developed in the module "mobile development" (4th semester) during my studies at the DHGE.

(back to top)

🎆 Showcase

!!! THIS IS THE LOOK OF THE APP BEFORE I REWORKED IT. WILL BE UPDATED SOON (hopefully) !!!

Add new desks

Get an overview

Analyse your data

Configure presets

Move your desk

Select between multiple desks

Interactive feedback through snackbars

Light mode :)

(back to top)

🔢 Getting started

1. Clone the repository

   git clone https://github.com/MhouneyLH/deskify.git

2. Install the dependencies

   flutter pub get

   (back to top)

🧪 Testing

I use Mocktail in combination with FlutterTest for testing.

How to add and run new tests?

1. Create a new file in the test folder. The name of the file should be name_of_the_file_test.dart. The structure of the test directory should be mirrored to the lib directory to keep the structure clean and understandable.

2. Import the needed libraries. (The automatic import does not work all the time sadly)

   import 'package:flutter_test/flutter_test.dart';
   import 'package:mocktail/mocktail.dart';
   
   // ...

3. Define your Mock-Classes. (If you need some)

   class MockMyClass extends Mock implements MyClass {}
   
   // ...

4. Write your tests. Orientate yourself on existing classes. (Consider when writing tests for multiple methods of a class to use a group for the tests of each method.)

5. Run the tests with the following command:

   flutter test

   (back to top)

👨🏻‍💼 Contributing

Contributions are always welcome! Please look at following commit-conventions, while contributing: https://www.conventionalcommits.org/en/v1.0.0/#summary 😃

1. Fork the project.
2. Pick or create an issue you want to work on.
3. Create your Feature-Branch. (git checkout -b feat/best_feature)
4. Commit your changes. (git commit -m 'feat: add some cool feature')
5. Push to the branch. (git push origin feat/best_feature)
6. Open a Pull-Request into the Develop-Branch.

(back to top)