Skip to content

Commit af5fbf7

Browse files
bugnanoFranco Bugnano
bugnano
authored and
Franco Bugnano
committed
Merge pull request #2 from talkjs/dev
First public release
2 parents ee8b97b + 748ff2d commit af5fbf7

19 files changed

+2821
-1
lines changed

‎.github/workflows/main.yml‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# This is a basic workflow to help you get started with Actions
2+
3+
name: Publish to Pub.dev
4+
5+
# Controls when the workflow will run
6+
on:
7+
## Triggers the workflow on push or pull request events but only for the main branch
8+
#push:
9+
# branches: [ main ]
10+
#pull_request:
11+
# branches: [ main ]
12+
13+
# Allows you to run this workflow manually from the Actions tab
14+
workflow_dispatch:
15+
16+
# A workflow run is made up of one or more jobs that can run sequentially or in parallel
17+
jobs:
18+
publishing:
19+
# The type of runner that the job will run on
20+
runs-on: ubuntu-latest
21+
22+
# Steps represent a sequence of tasks that will be executed as part of the job
23+
steps:
24+
# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
25+
- name: 'Checkout'
26+
uses: actions/checkout@v2 # required!
27+
28+
- name: '>> Dart package <<'
29+
uses: k-paxian/dart-package-publisher@master
30+
with:
31+
accessToken: ${{ secrets.OAUTH_ACCESS_TOKEN }}
32+
refreshToken: ${{ secrets.OAUTH_REFRESH_TOKEN }}
33+

‎.gitignore‎

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# Miscellaneous
2+
*.class
3+
*.log
4+
*.pyc
5+
*.swp
6+
.DS_Store
7+
.atom/
8+
.buildlog/
9+
.history
10+
.svn/
11+
12+
# IntelliJ related
13+
*.iml
14+
*.ipr
15+
*.iws
16+
.idea/
17+
18+
# The .vscode folder contains launch configuration and tasks you configure in
19+
# VS Code which you may wish to be included in version control, so this line
20+
# is commented out by default.
21+
#.vscode/
22+
23+
# Flutter/Dart/Pub related
24+
**/doc/api/
25+
.dart_tool/
26+
.flutter-plugins
27+
.flutter-plugins-dependencies
28+
.packages
29+
.pub-cache/
30+
.pub/
31+
build/
32+
33+
# Android related
34+
**/android/**/gradle-wrapper.jar
35+
**/android/.gradle
36+
**/android/captures/
37+
**/android/gradlew
38+
**/android/gradlew.bat
39+
**/android/local.properties
40+
**/android/**/GeneratedPluginRegistrant.java
41+
42+
# iOS/XCode related
43+
**/ios/**/*.mode1v3
44+
**/ios/**/*.mode2v3
45+
**/ios/**/*.moved-aside
46+
**/ios/**/*.pbxuser
47+
**/ios/**/*.perspectivev3
48+
**/ios/**/*sync/
49+
**/ios/**/.sconsign.dblite
50+
**/ios/**/.tags*
51+
**/ios/**/.vagrant/
52+
**/ios/**/DerivedData/
53+
**/ios/**/Icon?
54+
**/ios/**/Pods/
55+
**/ios/**/.symlinks/
56+
**/ios/**/profile
57+
**/ios/**/xcuserdata
58+
**/ios/.generated/
59+
**/ios/Flutter/App.framework
60+
**/ios/Flutter/Flutter.framework
61+
**/ios/Flutter/Flutter.podspec
62+
**/ios/Flutter/Generated.xcconfig
63+
**/ios/Flutter/app.flx
64+
**/ios/Flutter/app.zip
65+
**/ios/Flutter/flutter_assets/
66+
**/ios/Flutter/flutter_export_environment.sh
67+
**/ios/ServiceDefinitions.json
68+
**/ios/Runner/GeneratedPluginRegistrant.*
69+
70+
# Exceptions to above rules.
71+
!**/ios/**/default.mode1v3
72+
!**/ios/**/default.mode2v3
73+
!**/ios/**/default.pbxuser
74+
!**/ios/**/default.perspectivev3

‎.metadata‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# This file tracks properties of this Flutter project.
2+
# Used by Flutter tool to assess capabilities and perform upgrades etc.
3+
#
4+
# This file should be version controlled and should not be manually edited.
5+
6+
version:
7+
revision: 1d9032c7e1d867f071f2277eb1673e8f9b0274e3
8+
channel: stable
9+
10+
project_type: package

‎CHANGELOG.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
## 0.1.0
2+
3+
- Initial version.
4+

‎LICENSE‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
BSD 3-Clause License
2+
3+
Copyright (c) 2022, TalkJS
4+
5+
Redistribution and use in source and binary forms, with or without
6+
modification, are permitted provided that the following conditions are met:
7+
8+
1. Redistributions of source code must retain the above copyright notice, this
9+
list of conditions and the following disclaimer.
10+
11+
2. Redistributions in binary form must reproduce the above copyright notice,
12+
this list of conditions and the following disclaimer in the documentation
13+
and/or other materials provided with the distribution.
14+
15+
3. Neither the name of the copyright holder nor the names of its
16+
contributors may be used to endorse or promote products derived from
17+
this software without specific prior written permission.
18+
19+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
20+
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21+
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22+
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
23+
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24+
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
25+
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
26+
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
27+
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28+
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

‎README.md‎

Lines changed: 64 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,64 @@
1-
# flutter-sdk-victor
1+
# TalkJS Flutter SDK
2+
3+
Official TalkJS SDK for Flutter
4+
5+
**What is TalkJS?**
6+
7+
TalkJS lets you add user-to-user chat to your marketplace, on-demand app, or
8+
social platform.
9+
For more information, visit
10+
[talkjs.com](https://talkjs.com/?ref=jssdk-npm-readme).
11+
12+
![Screenshots of TalkJS running on various devices](https://talkjs.com/images/devices_home.jpg)
13+
14+
Don't hesitate to
15+
[let us know](https://talkjs.com/?chat)
16+
if you have any questions about TalkJS.
17+
18+
## Requirements
19+
20+
- Dart sdk: ">=2.15.0 <3.0.0"
21+
- Flutter: ">=2.8.1"
22+
- Android: `minSDKVersion 19`
23+
24+
## Installation
25+
26+
Edit the dependencies section of your project's `pubspec.yaml` file in your
27+
Flutter project as follows:
28+
29+
```yaml
30+
dependencies:
31+
talkjs_flutter: ^0.1.0
32+
```
33+
34+
Run the command: `flutter pub get` on the command line or through Android
35+
Studio's **Get dependencies** button.
36+
37+
38+
## Usage
39+
40+
Import TalkJS in your project source files.
41+
42+
```dart
43+
import 'package:talkjs_flutter/talkjs_flutter.dart';
44+
```
45+
46+
Then follow our
47+
[Flutter guide](https://talkjs.com/docs/Getting_Started/Frameworks/Flutter/)
48+
to start using TalkJS in your project.
49+
50+
## TalkJS is fully forward compatible
51+
We promise to never break API compatibility.
52+
We may at times deprecate methods or fields, but we will never remove them.
53+
If something that used to work stops working, then that's a bug.
54+
Please [report it](https://talkjs.com/?chat) and we'll fix it asap.
55+
56+
The package is being released in a beta state.
57+
The reason for this is that there are things that one can do with the TalkJS
58+
JavaScript SDK that aren't possible with the Flutter SDK.
59+
We will release v1.0.0 of this package once the two SDKs are similar in terms
60+
of features.
61+
This however does not take away from our commitment to always maintain backward
62+
compatibility.
63+
So you can be assured that the package is stable for production use.
64+

‎lib/assets/index.html‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="UTF-8">
5+
<meta name="viewport" content="user-scalable=no, initial-scale=1, maximum-scale=1, minimum-scale=1, width=device-width">
6+
<style>
7+
html, body, #talkjs-container {
8+
width: 100%;
9+
height: 100%;
10+
margin: 0;
11+
}
12+
</style>
13+
<script>
14+
(function(t,a,l,k,j,s){
15+
s=a.createElement('script');s.async=1;s.src="https://cdn.talkjs.com/talk.js";a.head.appendChild(s)
16+
;k=t.Promise;t.Talk={v:3,ready:{then:function(f){if(k)return new k(function(r,e){l.push([f,r,e])});l
17+
.push([f])},catch:function(){return k&&new k()},c:l}};})(window,document,[]);
18+
</script>
19+
</head>
20+
<body>
21+
<div id="talkjs-container"></div>
22+
</body>
23+
</html>

0 commit comments

Comments
 (0)