Skip to content
This repository has been archived by the owner on Oct 8, 2019. It is now read-only.

Latest commit

 

History

History
35 lines (18 loc) · 1.88 KB

README.md

File metadata and controls

35 lines (18 loc) · 1.88 KB

FlashCards

Build Status

Software team project with a goal to develop a multiplatform (i.e. web & android & iOS) flashcards learning app.

Contributing

Spotted an error? Something doesn't make sense? You have an excellent idea? Open an issue, but please, don't submit PRs. This project is curently developed as a part of software team project at the Faculty of Information Technology, CTU, so we will not accept your PRs.

Getting Started

The project has been written in Dart with AngularDart and Flutter frameworks. This makes project setup very simple. This project contains from 3 separate sub-projects—for common shared stings, AngularDart and Flutter.

For either AngularDart and Flutter you need the Dart SDK & package manager and you have to download dependencies in the bussiness logic project (common/) using pub get command.

Make sure you have Dart 2 installed (dev channel).

To set up AngularDart project, you have to move into angular/ directory and run pub get command to download all dependencies.

To run the project, you can simply use the pub run build_runner serve command. For more options on how to run the project, check the Angular README.

To set up Flutter project, you will need some prerequisites, i.e. the Flutter SDK—for running the mobile app—and the Android emulator, iOS emulator or a physical mobile device. Make sure you are all good with Flutter using the flutter doctor command.

To run the project, you can simply use the flutter run command.

License

Licensed under the MIT License.