SCT-Mobile

• SCT-Mobile
  • Introduction
  • Includes
  • Demo
  • Getting Started
    • Prerequisites
    • Steps
  • Roadmap
  • Project architecture

 

Introduction

SCT² is an open source project whose goal is for everyone to have a simple, fast and automated software to manage their business.

⚠ The project is still under development. ⚠ The app is connected to dev hosting ! Use the same link to use the backoffice to have the same data You can change that in the file lib/core/data/models/api.dart (line 6 to 8)

This cross-platform mobile application need an instance of the backend to work.

 

Includes

This project use Flutter to be cross-platform compatible

 

Demo

You can find some screenshots of the application in docs/demo.md

We have configured 2 instances of SCT² so that you can test before installing it in your home.

One instance connected to the master branch (stable | slow ring) available at https://sct-backend-prod.herokuapp.com

One instance connected to the dev branch (beta | fast ring) available at https://sct-backend-dev.herokuapp.com

They are hosted by Heroku for free so they can be in sleep mode when you try to acces to it. The first page loading can be a bit slow

Use theses login credentials to connect you, or by scan the QR code accessible in the backoffice email: a@aa.co password: azER&é34az

 

Getting Started

Prerequisites

To use the application you need some tools to build the app:

• Android Studio
• Flutter

Steps

1. After cloning the project or downloading it in .zip you have to check the installation section juste below.
2. Open Android Studio and clic on the play button at the top right corner to build the app on your phone
3. You're done ✨ The application will start after few minutes. You can close Android studio, the app is installed on your device

⚠ These steps are for test perpose, don't use it in production ! ⚠

 

Roadmap

Please check [Unreleased] tag in changelog to read what's next.

 

Project architecture

I use my own project architecture to be able to separate source code and compile one.

📦SCT-Mobile
 ┣ 📂android
 ┃ ┗ 📜 '> All android project files'
 ┣ 📂assets
 ┃ ┣ 📂fonts
 ┃ ┃ ┗ 📜 '> All fonts used in the application'
 ┃ ┗ 📂images
 ┃   ┗ 📜 '> All ipctures used in the application'
 ┣ 📂build
 ┣ 📂gen
 ┣ 📂ios
 ┃ ┗ 📜 '> All ios project files'
 ┣ 📂lib
 ┃ ┣ 📂core
 ┃ ┃ ┣ 📂data
 ┃ ┃ ┃ ┗ 📂models
 ┃ ┃ ┃ ┃ ┗ 📜 '> All data models used in the application'
 ┃ ┃ ┗ 📂viewmodels
 ┃ ┃ ┃ ┗ 📜 '> All view models used in the application'
 ┃ ┣ 📂ui
 ┃ ┃ ┣ 📂screens
 ┃ ┃ ┃ ┗ 📜 '> All screens used in the application'
 ┃ ┃ ┣ 📂shared
 ┃ ┃ ┃ ┗ 📜 '> All shared widgets used in the application'
 ┃ ┃ ┗ 📂widgets
 ┃ ┃ ┃ ┗ 📜 '> All other widgets used in the application'
 ┃ ┗ 📜main.dart
 ┣ 📂test
 ┃ ┗ 📜 '> All test of the application'
 ┣ 📜.flutter-plugins
 ┣ 📜.flutter-plugins-dependencies
 ┣ 📜.gitignore
 ┣ 📜.markdownlint.json
 ┣ 📜.metadata
 ┣ 📜.packages
 ┣ 📜CHANGELOG.md
 ┣ 📜LICENSE.md
 ┣ 📜pubspec.lock
 ┣ 📜pubspec.yaml
 ┗ 📜README.md