Vehikl Spare Parts

This application is an inventory tracker for the Greater Vehikl Team. Chairs, desks, monitors and much more all in one place.

Development setup

Requirements

• Flutter v3 install here
• Firebase Tools: npm i -g firebase-tools
• FlutterFire CLI: dart pub global activate flutterfire_cli
• Optional (but recommended): VS Code or Android Studio for better tooling around Flutter development

Setup

Similarly to npm scripts, Flutter uses derry to run custom scripts. All scripts are defined in the pubspec.yaml under scripts. Install derry globally:

flutter pub global activate derry

Local

First-time Setup

1. Install dependencies for running firebase functions and build them:

cd functions
npm install
npm run build

2. Authenticate with Firebase:

firebase login

3. Fetch Firebase configuration files (google-services.json and flutter_options.dart):

flutterfire configure

1. Start the Firebase emulators and seed data from /emulator_data:

firebase emulators:start --import ./emulator_data

2. Run the app:

flutter run -d <device> --dart-define=USE_EMULATORS=true

or run it through your favourite IDE.

Production

If you want to run the production app, make sure you have access to the production Spare Parts Firebase project.

1. Run the app:

flutter run -d <device>

or run it through your favourite IDE.

Testing

Before running the tests it is required to build mock classes with

derry build-mocks

Run the tests:

flutter test

Generate coverage:

flutter test --coverage

VS Code Extensions

• Flutter
• Dart
• Coverage Gutters
• Flutter Coverage

Useful Resources

• DYMO Legacy XML structure

Contributors

Thanks go to these wonderful people (emoji key):

Andrii Denysenko 💻 🎨 🤔 ⚠️ 👀	Alisa Vynohradova 💻 🎨 🤔 ⚠️	Karen Gallego 💻 🎨	Adam Frank 💻 🎨	whitfona 💻 🎨	Oleksandr Levinskyi 💻	Becs403 💻
Deep Panchal 💻
Add your contributions