hycop_light

Description:

hycop light

Hycop is a package for web applications that want to use PAS services provided by firebase or appwrite.
Features #
Hycop allows you to use the following 6 services provided by firebase or appwrite .
Database
RealTime
Serverless function
Account
Storage
*SocketIO
(*SocketIO is not a service provided by Firebase or Appwrite, but a service created by us.)
Getting started #
Example program will connect our demo server ( Firebase or Appwrite )
You can run demo program in example folder such as follows
% cd example
% flutter run -d chrome
Usage #
Please refer to the follwing example pages


Database
example/app/databse_example_page.dart


RealTime
example/app/real_example_page.dart


Storage
example/app/storage_example_page.dart


Serverless function
example/app/function_example_page.dart


Account
example/app/login_page.dart
example/app/register_page.dart
example/app/reset_password_confirm_page.dart
example/app/user_example_page.dart


SocketIO
example/app/socketio_example_page.dart


For Configuration
example/assets/hycop_config_example.json


Example program will connect our demo server ( Firbase or Appwrite )
If you want to have your own firebase or Appwrite server,
Follow the instruction below.

Using Firebase Server Case, Create a firebase account as follows

1.1 In Firebase console

Create Your Project
Register Your app
Create Your firestore database
Create Your firebase database (realtime database)
Create Your storage
Create Your functions

1.2 In your source code

Create a "hycop_config.json" file under the your assets folder and fill in the values.
You can refer to "example/assets/hycop_config_example.json" file
and you need to specify "hycop_config.json" in your pubspec.yaml file


Using Appwrite Server Case, Create a Your own Appwrite Servera as follows

2.1 Install Docker
Install Docker for your OS according to a commonly known method.
Docker must be installed on a server with at least 4G of memory.
A server can use https only if it has a domain name.
2.2 Install appwrite
Install appwrite by referring to the description on the appwrite.io homepage.
2.3 Appwrite settings
If you connect to the address of the appwrite server using a web browser, you can access the Appwrite console.

When connecting for the first time, enter your ID and password.
Create Project
Create Database

Unlike firebase, the necessary collections must be created here.
When creating a collections, do not forget to give appropriate read and write privileges.
To use RealTime Service, the 'hycop_delta' collection must be created.
To use Account Service, the 'hycop_user' collection must be created.
The schemas for hycop_user and hycop_delta are in the 'example/assets/collection_hycop_delta.json' and 'example/assets/collection_hycop_user.json'file.

Create API Key
Create Function
If necessary, you can create a Serverless function by following the instructions on the Appwrite.io page.


You need to create 'hycop_config.json' file with firebase or appwrite server information and put it in your assets folder.

The 'hycop_config.json' file can be created by referring to the example/assets/hycop_config_example.json file.
Of course you need to add the 'hycop_config.json' file to assets entry in your'pubspec.yaml' file.
Additional information #

Run #

cd example
flutter run -d chrome --web-renderer html
or #
flutter run -d chrome --web-renderer canvaskit
########## hycop 의 경우 윈도우와 리눅스를 지원하지 않는 패키지
WL cupertino_icons: ^1.0.2
-------------------------XX cloud_functions: ^4.0.7
#device_info_plus: ^3.2.2
WL logging: ^1.0.2
WL flutter_riverpod: ^1.0.4
WL synchronized: ^3.0.0
WL uuid: ^4.1.0
WL equatable: ^2.0.3
-------------------------XX firebase_database: ^10.3.3
#firebase: ^9.0.2
-------------------------WX firebase_core: ^2.21.0
------------------------WX cloud_firestore: ^4.3.1
------------------------XX cloud_firestore_web: ^3.2.1
WL appwrite: 11.0.0
WL routemaster: ^1.0.1
WL provider: ^6.0.1
WL font_awesome_flutter: ^10.1.0
WL shimmer: ^2.0.0
WL random_string: ^2.3.1
WL encrypt: ^5.0.1
------------------------WX firebase_storage: ^11.4.1
WL dart_appwrite: 10.0.0
-------------------------XX md5_file_checksum: ^1.0.3 // Web 도 안됨.
WL convert: ^3.0.2
WL crypto: ^3.0.2
-------------------------XX flutter_dropzone: ^3.0.5
WL socket_io_client: ^2.0.0
WL http: ^1.1.0
-------------------------XX extension_google_sign_in_as_googleapis_auth: ^2.0.7 // --> googleapis_auth 를 써야함.
-------------------------XX google_sign_in: ^5.4.2
WL flutter_webrtc: ^0.9.35
WL firebase_core_platform_interface: ^5.0.0
WL mediasoup_client_flutter: ^0.8.5
WL protoo_client: ^0.3.3 // web 이 안됨.
WL flutter_bloc: ^7.0.1
WL collection: ^1.17.0
다음 6개 파일은 hycop_light 의 고유 파일이다. 나머지는 모두 hycop 에서 매번 복사한 파일이다.
abs_database.dart
hycop_factory.dart
abs_storage.dart
hycop_utils.dart
hycop.dart
pubspec.yaml
firebase_storage.dart
model_enum.bat