CircuitVerse/mobile-app
Mobile App for CircuitVerse
gehe zu github herunterladenCircuitVerse Mobile
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
intomobile_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
FB_APP_ID
Github Configuration
GITHUB_OAUTH_CLIENT_ID
GITHUB_OAUTH_CLIENT_SECRET
Google Configuration
For Google OAuth we use google_sign_in. You’ll require a Java KeyStore(.jks
)
- Add
cv_debug.jks
inandroid/app/
. - Add
key.debug.properties
inandroid/
.
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
Dark Mode
Community
We would love to hear from you! We communicate on the following platforms:
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.
![](/images/banner-woo.jpg)
herausragende projekte, die mit CircuitVerse/mobile-app zusammenhängen, empfohlener download
AppFlowy
47859
AppFlowy is an open-source alternative to Notion. You are in charge of your data and customizations. Built with Flutter and Rust.
localsend
33797
An open-source cross-platform alternative to AirDrop
spotube
23772
🎧 Open source Spotify client that doesn't require Premium nor uses Electron! Available for both desktop & mobile!
revanced-manager
15035
💊 Application to use ReVanced on Android
gsy_github_app_flutter
14559
Flutter 超完整的开源项目,功能丰富,适合学习和日常使用。GSYGithubApp系列的优势:我们目前已经拥有Flutter、Weex、ReactNative、kotlin 四个版本。 功能齐全,项目框架内技术涉及面广,完成度高,持续维护,配套文章,适合全面学习,对比参考。跨平台的开源Github客户端App,更好的体验,更丰富的功能,旨在更好的日常管理和维护个人Github,提供更好更方便的驾车体验Σ( ̄。 ̄ノ)ノ。同款Weex版本 : https://github.com/CarGuo/GSYGithubAppWeex 、同款React Native版本 : https://github.com/CarGuo/GSYGithubApp 、原生 kotlin 版本 https://github.com/CarGuo/GSYGithubAppKotlin
dio
12249
A powerful HTTP client for Dart and Flutter, which supports global settings, Interceptors, FormData, aborting and canceling a request, files uploading and downloading, requests timeout, custom adapters, etc.
gopeed
11832
A modern download manager that supports all platforms. Built with Golang and Flutter.
bloc
11441
A predictable state management library that helps implement the BLoC design pattern
getx
9899
Open screens/snackbars/dialogs/bottomSheets without context, manage states and inject dependencies easily with Get.
flame
8846
A Flutter based game engine.
flutter_deer
7595
🦌 Flutter 练习项目(包括集成测试、可访问性测试)。内含完整UI设计图,更贴近真实项目的练习。Flutter practice project (including integration testing and accessibility testing). Contains complete UI design drawings for a more realistic practice project.
fish-redux
7343
An assembled flutter application framework.
fl_chart
6451
FL Chart is a highly customizable Flutter chart library that supports Line Chart, Bar Chart, Pie Chart, Scatter Chart, and Radar Chart.
pixez-flutter
6360
一个支持免代理直连及查看动图的第三方Pixiv flutter客户端
Flutter-Responsive-Admin-Panel-or-Dashboard
6355
Responsive Admin Panel or Dashboard using Flutter
aidea
6021
AIdea 是一款支持 GPT 以及国产大语言模型通义千问、文心一言等,支持 Stable Diffusion 文生图、图生图、 SDXL1.0、超分辨率、图片上色的全能型 APP。
riverpod
5828
A reactive caching and data-binding framework. Riverpod makes working with asynchronous code a breeze.
pikapika
5463
美观易用且无广告的漫画和游戏客户端,同时支持MacOS,Windows,Android,iOS。
provider
5029
InheritedWidgets, but simple
getwidget
4416
Most popular and easy to use open source UI library with 1000+ Widgets to build flutter app.