• 设为首页
  • 点击收藏
  • 手机版
    手机扫一扫访问
    迪恩网络手机版
  • 关注官方公众号
    微信扫一扫关注
    公众号

CircuitVerse/mobile-app: Mobile App for CircuitVerse

原作者: [db:作者] 来自: 网络 收藏 邀请

开源软件名称(OpenSource Name):

CircuitVerse/mobile-app

开源软件地址(OpenSource Url):

https://github.com/CircuitVerse/mobile-app

开源编程语言(OpenSource Language):

Dart 89.5%

开源软件介绍(OpenSource Introduction):

CircuitVerse Mobile

CI CD

CircuitVerse for mobile is a cross platform application built in flutter using CircuitVerse API.

Getting Started

Follow these instructions to build and run the project

Setup Flutter

A detailed guide for multiple platforms setup could be find here

Setup Project

  • Clone this repository using git clone https://github.com/CircuitVerse/mobile-app.git.
  • cd into mobile_app.
  • flutter pub get to get all the dependencies.
  • Generate files using Builder Runner (required)
flutter pub run build_runner build --delete-conflicting-outputs
  • Switch to mobile-app's git hooks (optional but recommended)
git config core.hooksPath .githooks/

# Make sure npm is installed to run the next command
npm install -g @commitlint/config-conventional @commitlint/cli

Mobile App enforces Conventional Commits specification, make sure to read and follow them.

Running the app

Make sure you have a connected Android/iOS device/simulator and run the following command to build and run the app in debug mode.

flutter run

Android OAuth Config

This project uses flutter version 1.20.2 and hence the support for compile time variables. To use compile time variables pass them in --dart-defines as flutter run --dart-define=VAR_NAME=VAR_VALUE. Supported dart-defines include :

Facebook Configuration

  1. FB_APP_ID

Github Configuration

  1. GITHUB_OAUTH_CLIENT_ID
  2. GITHUB_OAUTH_CLIENT_SECRET

Google Configuration

For Google OAuth we use google_sign_in. You'll require a Java KeyStore(.jks)

  1. Add cv_debug.jks in android/app/.
  2. Add key.debug.properties in android/.

Note: The OAuth Configuration section is not mandatory to get started. To get hold of the above secrets/files drop a message on slack with clear requirements and we'll take care.

Project Structure

mobile-app/lib/
├── config/                         # configuration files like environment_config
├── enums/                          # enum files
|   └── view_state.dart             # defines view states i.e Idle, Busy, Error
|   └── auth_state.dart             # defines auth states i.e logged in using Google/FB/Github/Email
├── l10n/                           # localization files like intl_en.arb
├── locale/                         # AppLocalization & AppLocalizationDelegate
├── managers/
|   └── dialog_manager.dart         # show dialogs using dialog navigation key
├── models/                         # model classes
|   └── dialog_models.dart          # dialog request and response models
        ...
├── services/                       # services
|   ├── API/                        # API implementations
|   └── dialog_service.dart         # handles dialog
|   └── local_storage_service.dart  # handles local storage (shared prefs)
├── ui/                             # UI layer
|  ├── views/                       # views
|  |  └── base_view.dart
|  |  └── cv_landing_view.dart
|  |  └── startup_view.dart
|  └── components/                  # shared components
├── utils/                          # utilities such as api_utils routes.dart and styles.dart
├── viewmodels/                     # Viewmodels layer
├── app_theme.dart                  # Shared App Colors/border decorations etc.
├── constants.dart                  # App constants
├── locator.dart                    # dependency injection using get_it
├── main.dart                       # <3 of the app

Features

Groups

  • Create Groups.
  • Edit/Update/Delete Groups.
  • Add/Delete Members to the group.

Assignments

  • Create/Add Assignment to a Group.
  • Edit Assignments.
  • Check Assignment Submissions.
  • Grade Assignment's projects.
  • Update/Delete Grades.

Projects/Circuits

  • Fork Project.
  • Edit/Delete Project.
  • Add/Delete Collaborators.
  • Star Project to favourites.
  • View Projects you created/starred.

Profile

  • View/Edit Profile

Screenshots

Splash View Home View NavDrawer View NavDrawer View Login Teachers View About View Contribute View Groups View Assignment Details View Assignment Date View Assignment Time View Login View Register View Profile View

Dark Mode

Splash View Dark Home View Dark Featured Circuit View Dark About View Dark Contribute View Dark Teachers View Dark Groups View Dark Login View Dark Register View Dark Assignment Details View Dark Assignment Date View Dark Assignment Time View Dark Profile View Dark

Community

We would love to hear from you! We communicate on the following platforms:

Slack

Contributing

Whether you have some feauture requests/ideas, code improvements, refactoring, performance improvements, help is always Welcome. The more is done, better it gets.

If you found any bugs, consider opening an issue.

License

This project is licensed under the MIT License.




鲜花

握手

雷人

路过

鸡蛋
该文章已有0人参与评论

请发表评论

全部评论

专题导读
上一篇:
miraclewkf/MobileNetV2-PyTorch: This is the PyTorch implement of MobileNet V2发布时间:2022-08-30
下一篇:
polinema-mobile/2019-mobile09发布时间:2022-08-30
热门推荐
阅读排行榜

扫描微信二维码

查看手机版网站

随时了解更新最新资讯

139-2527-9053

在线客服(服务时间 9:00~18:00)

在线QQ客服
地址:深圳市南山区西丽大学城创智工业园
电邮:jeky_zhao#qq.com
移动电话:139-2527-9053

Powered by 互联科技 X3.4© 2001-2213 极客世界.|Sitemap