DanteX

KO | EN

gitlite — search

#javascript #react #typescript #golang #android #deep-learning #linux #docker #nodejs #cli #awesome-list #vue #ios #open-source

(★ 31)

Dante - Book Tracker Cross Platform Implementation

DanteX 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# DanteX

Cross Platform implementation of Dante - Book Tracker.

Dante lets you manage all your books by simply scanning the ISBN barcode of the book.
It will automatically grab all information from Googles book database. The app let's you arrange
your books into 3 different categories, whether you have read the book, are currently reading the
book or saved the book for later. So you can simply keep track of your progress of all your books
and their current states.

### General Overview

DanteX mainly relies on Google/Firebase services for a variety of tasks. It uses `Crashlytics`
for crash reporting, `Firebase Auth` and `Google SignIn` for authentication, `Firebase Storage` for
cover storage, `Firebase Database` for storing books and recommendations.

DanteX supports the following platforms:

- iOS
- Android
- Web

The build/deployment process is coupled to the following branches:

- `develop` for the actual development
- `internal-testing` for deploying it to Firebase App Distribution
- `main` for the deployment to the Google Play Store, App Store and to the website

`codemagic.io` is used to deploy the apps to the respective services and portals. `@shockbytes` is
in charge of configuring CodeMagic for these channels.

### Naming Conventions and Code Structure

In general, the project adheres to the dart guidelines. Each class should be defined in a separate
file. File names are all named lowercase with underscores, like `book_repository.dart`. Interfaces
are used especially in the data layer, for repositories and network functionality, as this needs
to be mocked for future tests. The app uses Riverpod for dependency injection and reactive state changes. The developers should mainly rely on Riverpod classes for manipulating view state
(notable exceptions are sole UI components, where a stateful widget is the better solution).

**Developers should always favor `StatelessWidgets`/`ConsumerWidgets` over `StatefulWidgets`/`ConsumerStatefulWidgets` when implementing pages!**

Source code structure:

- providers
  - Contains the Riverpod code for dependency injection and state management.
- core
  - Contains essential classes and functions used throughout the whole app.
- data
  - Contains repositories and services for storing/loading data for specific modules, like books, statistics, backups, etc...
  - Data directory structure:
    - api: Contains network code for communication with external services. Not required for most modules
    - entity: Contains the entity objects, like `book.dart`. Can also contain data classes for the api, in the `remote` directory
    - Root: Contains the repository interface with the implementation, and other services.
- ui
  - The different pages are logically grouped in a module. Each page has a dedicated class.
- util
  - Utility methods and extensions.

### Dependency Injection

Riverpod is used for dependency injection. The `providers` directory contains all the providers for
the app. The app dependencies are defined by Riverpod and can we overwritten in tests as required.

### Navigation

The [go_router](https://pub.dev/packages/go_router) package is used for navigation. The navigation
needs to support navigation patterns on Android, iOS and Web. Due to the later, `go_router` is a
perfect candidate for navigation.

The navigation routes are encapsulated in the enum `DanteRoute` class. The main reason for doing
this, is that all routes are defined in one place. The risk of using wrong routes with
corresponding 404 errors are mitigated.

### Developer Setup

Android Studio is the recommended IDE for every OS, although it is not mandatory to use it.

The source code has a single sensitive dependency, which is the `GoogleService.json` respectively
`GoogleService.plist` file and in `firebase_options.dart`.
**The configuration files will be provided by @shockbytes upon request**.

Once the repository is cloned down, developers should run a `pub get` to get the required dependencies. After this developers will need to run `dart run build_runner build --delete-conflicting-outputs` to generate the required codegen files for the project.

### Testing

Developers should be aiming for tests to cover all the major functionality. We are using `Mockito` to
generate mocks required for testing. To be able to run the tests, you'll need to run
`flutter pub run build_runner build` from the repo root to generate the mocks required for the tests.

### String translations

All static text strings should be in the translations files located at `/lib/l10n`.
To use the translations, add the key value pair to the translation files and then run `flutter pub get`.
You can then access the translation value by doing `AppLocalizations.of(context)!.your_key`.

The overview of the features to be worked on can be found in the following Github project:
https://github.com/users/shockbytes/projects/1/views/1

In case of unclear requirements, developers can always reach out on Discord and ask for
clarification in this channel:
https://discord.com/channels/824694597728993390/1037365721363136572

DanteX

DanteX 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

DanteX

DanteX 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README