mirror of
https://github.com/h7x4/Jisho-Study-Tool.git
synced 2024-12-21 05:27:29 +01:00
Add licenses and update docs (#39)
* Add info sections to application * Update README * Make screenshots bigger * A little less big * Fix heading sizes
This commit is contained in:
GitHub
parent
f6134c07a1
commit
76f8cc6c86
BIN
.github/screenshots/draw_search.png
vendored
Normal file
BIN
.github/screenshots/draw_search.png
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 72 KiB |
BIN
.github/screenshots/history.png
vendored
Normal file
BIN
.github/screenshots/history.png
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 63 KiB |
BIN
.github/screenshots/kanji_result.png
vendored
Normal file
BIN
.github/screenshots/kanji_result.png
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 212 KiB |
BIN
.github/screenshots/kanji_search.png
vendored
Normal file
BIN
.github/screenshots/kanji_search.png
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 145 KiB |
BIN
.github/screenshots/radical_search.png
vendored
Normal file
BIN
.github/screenshots/radical_search.png
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 125 KiB |
BIN
.github/screenshots/search.png
vendored
Normal file
BIN
.github/screenshots/search.png
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 68 KiB |
BIN
.github/screenshots/search_result.png
vendored
Normal file
BIN
.github/screenshots/search_result.png
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 134 KiB |
77
README.md
77
README.md
@ -1,22 +1,77 @@
|
||||
[]()
|
||||
[![CircleCI Status][circleci-badge]][circleci]
|
||||
|
||||
<p align="center">
|
||||
<img src="assets/images/logo/logo_icon_transparent_green.png" width=100/>
|
||||
|
||||
</p>
|
||||
|
||||
# Jisho Study tool
|
||||
A japanese dictionary with features for making studying the language easier. For the time being, it's mostly a frontend for [Jisho.org][jisho]. It is still in beta, and will stay in beta for some time. Its main data source is the [unofficial_jisho_api][unofficial_jisho_api].
|
||||
|
||||
A japanese dictionary with features for making studying the language easier.
|
||||
## Screenshots
|
||||
|
||||
<p align="center">
|
||||
<img src=".github/screenshots/search.png" width="250"/>
|
||||
<img src=".github/screenshots/kanji_search.png" width="250"/>
|
||||
<img src=".github/screenshots/radical_search.png" width="250"/>
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<img src=".github/screenshots/search_result.png" width="250"/>
|
||||
<img src=".github/screenshots/kanji_result.png" width="250"/>
|
||||
<img src=".github/screenshots/draw_search.png" width="250"/>
|
||||
</p>
|
||||
|
||||
[See all screenshots][screenshots]
|
||||
|
||||
## Search
|
||||
|
||||
Standard search using Jishos API. This returns standard Jisho search results, including what you'd find if you searched through the search bar without any modifiers
|
||||
Search using the Jisho API.
|
||||
This returns the same Jisho search results you would find by default search without any modifiers (like `#kanji` or `#adverbs`).
|
||||
There is also an `Extensive search` mode which does another request to fetch detailed information, at the expense of keeping the user waiting.
|
||||
This detailed information might include example sentences, audio, and other supplementary information.
|
||||
|
||||
## Kanji Search
|
||||
|
||||
Jisho kanji search just like using the #kanji modifier in the jisho search bar. This will give you detailed information about things like drawing order, radicals, different kinds of ranks and statistics and some onyomi and kunyomi example words.
|
||||
There's several ways to search for kanji.
|
||||
You can search for kanji manually, by typing it in (or by choosing from a large copy-pasted message).
|
||||
You can also search for kanji by trying to draw it.
|
||||
There's also grade based search, and radical based search.
|
||||
The data returned usually includes the kanjis radical, meanings, pronounciations, stroke order, some statistics and example usage.
|
||||
|
||||
## Upcoming Features
|
||||
## Development environment
|
||||
|
||||
- [ ] Different kinds of kanji input like radicals and grade based lists
|
||||
- [ ] Favorites, history and custom lists
|
||||
- [ ] Anki export
|
||||
- [ ] Memo cards
|
||||
- [ ] Cloud sync
|
||||
- [ ] Dark theme
|
||||
To set up a development environment, I would suggest heading over to [flutter.dev][flutter-get-started] and following the installation instructions.
|
||||
|
||||
Apart from that, there is no other tools being used at the current time.
|
||||
|
||||
## Aim
|
||||
|
||||
Why am I making this application, when there's thousands of japanese dictionary apps out there?
|
||||
|
||||
I've spent quite a lot of time studying this language.
|
||||
During study sessions, most of my time would go towards looking for information.
|
||||
I would often come across new kanji for which I don't know the stroke order, so I ended up fighting with the handwriting recognizers.
|
||||
Sometimes, I was looking at a word where I had some translations for the word, but no idea how to actually use it.
|
||||
Finding words that were worthwile to learn could also be hard, and I've probably memorized a bunch of uncommon words that people don't really use.
|
||||
I also frequently went to places without access to the internet.
|
||||
|
||||
To resolve these problems, I've tried several study aiding apps.
|
||||
Most were good in some ways, but there wasn't really any app that filled all my requirements.
|
||||
Jisho.org however, provides most of my needs.
|
||||
There was a lot of Jisho.org apps, but most were missing a lot of the features that were critical to me.
|
||||
That is the main problem this app is trying to solve.
|
||||
I'm aiming to make the app I wished I had while studying.
|
||||
|
||||
## Thanks to
|
||||
|
||||
- Kim, Miwa and Andrew, who did the absolutely incredible work of making Jisho.org
|
||||
- Mistvall, who created the original API library [unofficial-jisho-api][unofficial-jisho-api].
|
||||
|
||||
[circleci-badge]: https://circleci.com/gh/h7x4ABk3g/Jisho-Study-Tool.svg?style=shield
|
||||
[circleci]: https://app.circleci.com/pipelines/github/h7x4ABk3g/Jisho-Study-Tool
|
||||
[flutter-get-started]: https://docs.flutter.dev/get-started/install
|
||||
[jisho]: https://jisho.org
|
||||
[screenshots]: .github/screenshots/
|
||||
[unofficial-jisho-api]: https://www.npmjs.com/package/unofficial-jisho-api
|
||||
[unofficial_jisho_api]: https://pub.dev/packages/unofficial_jisho_api
|
||||
4
assets/licenses.json
Normal file
4
assets/licenses.json
Normal file
@ -0,0 +1,4 @@
|
||||
{
|
||||
"droid-fonts": "assets/licenses/droid-fonts.txt",
|
||||
"noto-fonts": "assets/licenses/noto-fonts.txt"
|
||||
}
|
||||
202
assets/licenses/droid-fonts.txt
Normal file
202
assets/licenses/droid-fonts.txt
Normal file
@ -0,0 +1,202 @@
|
||||
|
||||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||
or by an individual or Legal Entity authorized to submit on behalf of
|
||||
the copyright owner. For the purposes of this definition, "submitted"
|
||||
means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems,
|
||||
and issue tracking systems that are managed by, or on behalf of, the
|
||||
Licensor for the purpose of discussing and improving the Work, but
|
||||
excluding communication that is conspicuously marked or otherwise
|
||||
designated in writing by the copyright owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
APPENDIX: How to apply the Apache License to your work.
|
||||
|
||||
To apply the Apache License to your work, attach the following
|
||||
boilerplate notice, with the fields enclosed by brackets "[]"
|
||||
replaced with your own identifying information. (Don't include
|
||||
the brackets!) The text should be enclosed in the appropriate
|
||||
comment syntax for the file format. We also recommend that a
|
||||
file or class name and description of purpose be included on the
|
||||
same "printed page" as the copyright notice for easier
|
||||
identification within third-party archives.
|
||||
|
||||
Copyright [yyyy] [name of copyright owner]
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
94
assets/licenses/noto-fonts.txt
Normal file
94
assets/licenses/noto-fonts.txt
Normal file
@ -0,0 +1,94 @@
|
||||
Copyright 2018 The Noto Project Authors (github.com/googlei18n/noto-fonts)
|
||||
|
||||
This Font Software is licensed under the SIL Open Font License,
|
||||
Version 1.1.
|
||||
|
||||
This license is copied below, and is also available with a FAQ at:
|
||||
http://scripts.sil.org/OFL
|
||||
|
||||
-----------------------------------------------------------
|
||||
SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
|
||||
-----------------------------------------------------------
|
||||
|
||||
PREAMBLE
|
||||
The goals of the Open Font License (OFL) are to stimulate worldwide
|
||||
development of collaborative font projects, to support the font
|
||||
creation efforts of academic and linguistic communities, and to
|
||||
provide a free and open framework in which fonts may be shared and
|
||||
improved in partnership with others.
|
||||
|
||||
The OFL allows the licensed fonts to be used, studied, modified and
|
||||
redistributed freely as long as they are not sold by themselves. The
|
||||
fonts, including any derivative works, can be bundled, embedded,
|
||||
redistributed and/or sold with any software provided that any reserved
|
||||
names are not used by derivative works. The fonts and derivatives,
|
||||
however, cannot be released under any other type of license. The
|
||||
requirement for fonts to remain under this license does not apply to
|
||||
any document created using the fonts or their derivatives.
|
||||
|
||||
DEFINITIONS
|
||||
"Font Software" refers to the set of files released by the Copyright
|
||||
Holder(s) under this license and clearly marked as such. This may
|
||||
include source files, build scripts and documentation.
|
||||
|
||||
"Reserved Font Name" refers to any names specified as such after the
|
||||
copyright statement(s).
|
||||
|
||||
"Original Version" refers to the collection of Font Software
|
||||
components as distributed by the Copyright Holder(s).
|
||||
|
||||
"Modified Version" refers to any derivative made by adding to,
|
||||
deleting, or substituting -- in part or in whole -- any of the
|
||||
components of the Original Version, by changing formats or by porting
|
||||
the Font Software to a new environment.
|
||||
|
||||
"Author" refers to any designer, engineer, programmer, technical
|
||||
writer or other person who contributed to the Font Software.
|
||||
|
||||
PERMISSION & CONDITIONS
|
||||
Permission is hereby granted, free of charge, to any person obtaining
|
||||
a copy of the Font Software, to use, study, copy, merge, embed,
|
||||
modify, redistribute, and sell modified and unmodified copies of the
|
||||
Font Software, subject to the following conditions:
|
||||
|
||||
1) Neither the Font Software nor any of its individual components, in
|
||||
Original or Modified Versions, may be sold by itself.
|
||||
|
||||
2) Original or Modified Versions of the Font Software may be bundled,
|
||||
redistributed and/or sold with any software, provided that each copy
|
||||
contains the above copyright notice and this license. These can be
|
||||
included either as stand-alone text files, human-readable headers or
|
||||
in the appropriate machine-readable metadata fields within text or
|
||||
binary files as long as those fields can be easily viewed by the user.
|
||||
|
||||
3) No Modified Version of the Font Software may use the Reserved Font
|
||||
Name(s) unless explicit written permission is granted by the
|
||||
corresponding Copyright Holder. This restriction only applies to the
|
||||
primary font name as presented to the users.
|
||||
|
||||
4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
|
||||
Software shall not be used to promote, endorse or advertise any
|
||||
Modified Version, except to acknowledge the contribution(s) of the
|
||||
Copyright Holder(s) and the Author(s) or with their explicit written
|
||||
permission.
|
||||
|
||||
5) The Font Software, modified or unmodified, in part or in whole,
|
||||
must be distributed entirely under this license, and must not be
|
||||
distributed under any other license. The requirement for fonts to
|
||||
remain under this license does not apply to any document created using
|
||||
the Font Software.
|
||||
|
||||
TERMINATION
|
||||
This license becomes null and void if any of the above conditions are
|
||||
not met.
|
||||
|
||||
DISCLAIMER
|
||||
THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
||||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
|
||||
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
|
||||
OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
|
||||
COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
|
||||
INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
|
||||
DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
||||
FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
|
||||
OTHER DEALINGS IN THE FONT SOFTWARE.
|
||||
@ -1,15 +1,8 @@
|
||||
import 'package:flutter/material.dart';
|
||||
import 'package:flutter_svg/flutter_svg.dart';
|
||||
import 'package:unofficial_jisho_api/api.dart';
|
||||
import 'package:url_launcher/url_launcher.dart';
|
||||
|
||||
Future<void> _launch(String url) async {
|
||||
if (await canLaunch(url)) {
|
||||
launch(url);
|
||||
} else {
|
||||
debugPrint('Could not open url: $url');
|
||||
}
|
||||
}
|
||||
import '../../../../services/open_webpage.dart';
|
||||
|
||||
final BoxDecoration _iconStyle = BoxDecoration(
|
||||
color: Colors.white,
|
||||
@ -30,7 +23,7 @@ Widget _wiki({
|
||||
decoration: _iconStyle,
|
||||
margin: EdgeInsets.fromLTRB(0, 0, 10, isJapanese ? 12 : 10),
|
||||
child: IconButton(
|
||||
onPressed: () => _launch(link),
|
||||
onPressed: () => open_webpage(link),
|
||||
icon: SvgPicture.asset('assets/images/wikipedia.svg'),
|
||||
),
|
||||
),
|
||||
@ -56,7 +49,7 @@ Widget _wiki({
|
||||
Widget _dbpedia(String link) => Container(
|
||||
decoration: _iconStyle,
|
||||
child: IconButton(
|
||||
onPressed: () => _launch(link),
|
||||
onPressed: () => open_webpage(link),
|
||||
icon: Image.asset(
|
||||
'assets/images/dbpedia.png',
|
||||
),
|
||||
@ -107,7 +100,7 @@ class Links extends StatelessWidget {
|
||||
final List<Widget> otherLinks = [
|
||||
for (final link in newLinks) ...[
|
||||
InkWell(
|
||||
onTap: () => _launch(link.url),
|
||||
onTap: () => open_webpage(link.url),
|
||||
child: Text(
|
||||
link.text,
|
||||
style: const TextStyle(color: Colors.blue),
|
||||
|
||||
@ -1,6 +1,9 @@
|
||||
import 'dart:convert';
|
||||
import 'dart:io';
|
||||
|
||||
import 'package:flutter/foundation.dart';
|
||||
import 'package:flutter/material.dart';
|
||||
import 'package:flutter/services.dart' show rootBundle;
|
||||
import 'package:get_it/get_it.dart';
|
||||
import 'package:path/path.dart';
|
||||
import 'package:path_provider/path_provider.dart';
|
||||
@ -25,6 +28,16 @@ Future<void> setupSharedPreferences() async {
|
||||
GetIt.instance.registerSingleton<SharedPreferences>(prefs);
|
||||
}
|
||||
|
||||
void registerExtraLicenses() => LicenseRegistry.addLicense(() async* {
|
||||
final jsonString = await rootBundle.loadString('assets/licenses.json');
|
||||
final Map<String, dynamic> jsonData = jsonDecode(jsonString);
|
||||
for (final license in jsonData.entries)
|
||||
yield LicenseEntryWithLineBreaks(
|
||||
[license.key],
|
||||
await rootBundle.loadString(license.value as String),
|
||||
);
|
||||
});
|
||||
|
||||
Future<void> main() async {
|
||||
WidgetsFlutterBinding.ensureInitialized();
|
||||
|
||||
@ -33,6 +46,8 @@ Future<void> main() async {
|
||||
setupSharedPreferences(),
|
||||
]);
|
||||
|
||||
registerExtraLicenses();
|
||||
|
||||
runApp(const MyApp());
|
||||
}
|
||||
|
||||
|
||||
@ -1,6 +1,8 @@
|
||||
import 'package:flutter/material.dart';
|
||||
|
||||
import '../screens/home.dart';
|
||||
import '../screens/info/about.dart';
|
||||
import '../screens/info/licenses.dart';
|
||||
import '../screens/search/kanji_result_page.dart';
|
||||
import '../screens/search/search_mechanisms/drawing.dart';
|
||||
import '../screens/search/search_mechanisms/grade_list.dart';
|
||||
@ -35,7 +37,14 @@ Route<Widget> generateRoute(RouteSettings settings) {
|
||||
|
||||
case Routes.kanjiSearchRadicals:
|
||||
final prechosenRadical = args as String?;
|
||||
return MaterialPageRoute(builder: (_) => KanjiRadicalSearch(prechosenRadical: prechosenRadical));
|
||||
return MaterialPageRoute(
|
||||
builder: (_) => KanjiRadicalSearch(prechosenRadical: prechosenRadical),
|
||||
);
|
||||
|
||||
case Routes.about:
|
||||
return MaterialPageRoute(builder: (_) => const AboutView());
|
||||
case Routes.aboutLicenses:
|
||||
return MaterialPageRoute(builder: (_) => const LicensesView());
|
||||
|
||||
// TODO: Add more specific error screens.
|
||||
case Routes.errorNotFound:
|
||||
|
||||
@ -5,6 +5,8 @@ class Routes {
|
||||
static const String kanjiSearchDraw = '/kanjiSearch/draw';
|
||||
static const String kanjiSearchGrade = '/kanjiSearch/grade';
|
||||
static const String kanjiSearchRadicals = '/kanjiSearch/radicals';
|
||||
static const String about = '/info/about';
|
||||
static const String aboutLicenses = '/info/licenses';
|
||||
static const String errorNotFound = '/error/404';
|
||||
static const String errorNetwork = '/error/network';
|
||||
static const String errorOther = '/error/other';
|
||||
|
||||
148
lib/screens/info/about.dart
Normal file
148
lib/screens/info/about.dart
Normal file
@ -0,0 +1,148 @@
|
||||
import 'package:flutter/material.dart';
|
||||
import 'package:mdi/mdi.dart';
|
||||
|
||||
import '../../components/common/denshi_jisho_background.dart';
|
||||
import '../../services/open_webpage.dart';
|
||||
import '../../settings.dart';
|
||||
|
||||
class AboutView extends StatelessWidget {
|
||||
const AboutView({Key? key}) : super(key: key);
|
||||
|
||||
static const double _verticalSeparation = 18.0;
|
||||
|
||||
Widget _header(context) => Column(
|
||||
children: [
|
||||
const SizedBox(height: _verticalSeparation),
|
||||
Text(
|
||||
'Jisho Study Tool',
|
||||
style: Theme.of(context).textTheme.headline5,
|
||||
),
|
||||
const SizedBox(height: _verticalSeparation),
|
||||
Row(
|
||||
children: [
|
||||
const Expanded(child: SizedBox()),
|
||||
Expanded(
|
||||
child: Image.asset(
|
||||
'assets/images/logo/logo_icon_transparent_green.png',
|
||||
),
|
||||
),
|
||||
const Expanded(child: SizedBox()),
|
||||
],
|
||||
),
|
||||
const SizedBox(height: _verticalSeparation),
|
||||
Text(
|
||||
'Version: $appVersion',
|
||||
style: Theme.of(context).textTheme.bodyText2,
|
||||
),
|
||||
const SizedBox(height: _verticalSeparation),
|
||||
],
|
||||
);
|
||||
|
||||
@override
|
||||
Widget build(BuildContext context) {
|
||||
return Scaffold(
|
||||
appBar: AppBar(title: const Text('About')),
|
||||
body: DenshiJishoBackground(
|
||||
child: Padding(
|
||||
padding: const EdgeInsets.symmetric(horizontal: 10),
|
||||
child: Column(
|
||||
crossAxisAlignment: CrossAxisAlignment.start,
|
||||
// crossAxisAlignment: CrossAxisAlignment.center,
|
||||
children: [
|
||||
_header(context),
|
||||
Padding(
|
||||
padding: const EdgeInsets.symmetric(horizontal: 30),
|
||||
child: Text(
|
||||
'Jisho Study Tool is a frontend for Jisho.org, a a powerful Japanese-English dictionary. '
|
||||
"It's made to aid you in your journey towards Japanese proficiency. "
|
||||
'More features to come!',
|
||||
style: Theme.of(context).textTheme.bodyText2,
|
||||
),
|
||||
),
|
||||
|
||||
const SizedBox(height: 2 * _verticalSeparation),
|
||||
|
||||
Text('Contact:', style: Theme.of(context).textTheme.headline6),
|
||||
const SizedBox(height: _verticalSeparation),
|
||||
IntrinsicHeight(
|
||||
child: Row(
|
||||
children: [
|
||||
Container(
|
||||
decoration: BoxDecoration(
|
||||
color: Colors.black,
|
||||
borderRadius: BorderRadius.circular(15),
|
||||
),
|
||||
child: IconButton(
|
||||
iconSize: 50,
|
||||
onPressed: () => open_webpage(
|
||||
'https://github.com/h7x4ABk3g/Jisho-Study-Tool',
|
||||
),
|
||||
icon: const Icon(Mdi.github),
|
||||
),
|
||||
),
|
||||
const SizedBox(width: 20),
|
||||
Expanded(
|
||||
child: InkWell(
|
||||
onTap: () => open_webpage(
|
||||
'mailto:developer@jishostudytool.app',
|
||||
),
|
||||
child: Column(
|
||||
mainAxisAlignment: MainAxisAlignment.center,
|
||||
crossAxisAlignment: CrossAxisAlignment.start,
|
||||
children: const [
|
||||
Text('You can reach me at:'),
|
||||
Text(
|
||||
'developer@jishostudytool.app',
|
||||
style: TextStyle(color: Colors.blue),
|
||||
),
|
||||
],
|
||||
),
|
||||
),
|
||||
),
|
||||
],
|
||||
),
|
||||
),
|
||||
const SizedBox(height: _verticalSeparation),
|
||||
Text(
|
||||
'File a bug report:',
|
||||
style: Theme.of(context).textTheme.headline6,
|
||||
),
|
||||
InkWell(
|
||||
onTap: () => open_webpage(
|
||||
'mailto:bugs@jishostudytool.app',
|
||||
),
|
||||
child: Container(
|
||||
alignment: Alignment.center,
|
||||
padding: const EdgeInsets.symmetric(
|
||||
vertical: _verticalSeparation,
|
||||
),
|
||||
child: const Text(
|
||||
'bugs@jishostudytool.app',
|
||||
style: TextStyle(color: Colors.blue),
|
||||
),
|
||||
),
|
||||
),
|
||||
Text(
|
||||
'I would really appreciate it if you send in some bug reports! '
|
||||
'If you find something weird, '
|
||||
'please send me a mail, or open an issue on GitHub.',
|
||||
style: Theme.of(context).textTheme.bodyText2,
|
||||
),
|
||||
const SizedBox(height: _verticalSeparation),
|
||||
Center(
|
||||
child: Text(
|
||||
'頑張れ！',
|
||||
style: Theme.of(context)
|
||||
.textTheme
|
||||
.headline5
|
||||
?.merge(japaneseFont.textStyle),
|
||||
),
|
||||
),
|
||||
// const SizedBox(height: 6 * _verticalSeparation),
|
||||
],
|
||||
),
|
||||
),
|
||||
),
|
||||
);
|
||||
}
|
||||
}
|
||||
27
lib/screens/info/licenses.dart
Normal file
27
lib/screens/info/licenses.dart
Normal file
@ -0,0 +1,27 @@
|
||||
import 'package:flutter/material.dart';
|
||||
|
||||
import '../../settings.dart';
|
||||
|
||||
class LicensesView extends StatelessWidget {
|
||||
const LicensesView({Key? key}) : super(key: key);
|
||||
|
||||
@override
|
||||
Widget build(BuildContext context) => LicensePage(
|
||||
applicationName: 'Jisho Study Tool',
|
||||
applicationVersion: 'Version: $appVersion',
|
||||
applicationIcon: Padding(
|
||||
padding: const EdgeInsets.symmetric(vertical: 30),
|
||||
child: Row(
|
||||
children: [
|
||||
const Expanded(child: SizedBox()),
|
||||
Expanded(
|
||||
child: Image.asset(
|
||||
'assets/images/logo/logo_icon_transparent_green.png',
|
||||
),
|
||||
),
|
||||
const Expanded(child: SizedBox()),
|
||||
],
|
||||
),
|
||||
),
|
||||
);
|
||||
}
|
||||
@ -6,6 +6,8 @@ import 'package:mdi/mdi.dart';
|
||||
import '../bloc/theme/theme_bloc.dart';
|
||||
import '../components/common/denshi_jisho_background.dart';
|
||||
import '../models/history/search.dart';
|
||||
import '../routing/routes.dart';
|
||||
import '../services/open_webpage.dart';
|
||||
import '../settings.dart';
|
||||
|
||||
class SettingsView extends StatefulWidget {
|
||||
@ -159,40 +161,41 @@ class _SettingsViewState extends State<SettingsView> {
|
||||
),
|
||||
],
|
||||
),
|
||||
SettingsSection(
|
||||
title: 'Cache',
|
||||
titleTextStyle: _titleTextStyle,
|
||||
tiles: <SettingsTile>[
|
||||
SettingsTile.switchTile(
|
||||
title: 'Cache grade 1-7 kanji',
|
||||
switchValue: false,
|
||||
onToggle: (v) {},
|
||||
enabled: false,
|
||||
switchActiveColor: AppTheme.jishoGreen.background,
|
||||
),
|
||||
SettingsTile.switchTile(
|
||||
title: 'Cache grade standard kanji',
|
||||
switchValue: false,
|
||||
onToggle: (v) {},
|
||||
enabled: false,
|
||||
switchActiveColor: AppTheme.jishoGreen.background,
|
||||
),
|
||||
SettingsTile.switchTile(
|
||||
title: 'Cache all favourites',
|
||||
switchValue: false,
|
||||
onToggle: (v) {},
|
||||
enabled: false,
|
||||
switchActiveColor: AppTheme.jishoGreen.background,
|
||||
),
|
||||
SettingsTile.switchTile(
|
||||
title: 'Cache all searches',
|
||||
switchValue: false,
|
||||
onToggle: (v) {},
|
||||
enabled: false,
|
||||
switchActiveColor: AppTheme.jishoGreen.background,
|
||||
),
|
||||
],
|
||||
),
|
||||
// TODO: This will be left commented until caching is implemented
|
||||
// SettingsSection(
|
||||
// title: 'Cache',
|
||||
// titleTextStyle: _titleTextStyle,
|
||||
// tiles: <SettingsTile>[
|
||||
// SettingsTile.switchTile(
|
||||
// title: 'Cache grade 1-7 kanji',
|
||||
// switchValue: false,
|
||||
// onToggle: (v) {},
|
||||
// enabled: false,
|
||||
// switchActiveColor: AppTheme.jishoGreen.background,
|
||||
// ),
|
||||
// SettingsTile.switchTile(
|
||||
// title: 'Cache grade standard kanji',
|
||||
// switchValue: false,
|
||||
// onToggle: (v) {},
|
||||
// enabled: false,
|
||||
// switchActiveColor: AppTheme.jishoGreen.background,
|
||||
// ),
|
||||
// SettingsTile.switchTile(
|
||||
// title: 'Cache all favourites',
|
||||
// switchValue: false,
|
||||
// onToggle: (v) {},
|
||||
// enabled: false,
|
||||
// switchActiveColor: AppTheme.jishoGreen.background,
|
||||
// ),
|
||||
// SettingsTile.switchTile(
|
||||
// title: 'Cache all searches',
|
||||
// switchValue: false,
|
||||
// onToggle: (v) {},
|
||||
// enabled: false,
|
||||
// switchActiveColor: AppTheme.jishoGreen.background,
|
||||
// ),
|
||||
// ],
|
||||
// ),
|
||||
SettingsSection(
|
||||
title: 'Data',
|
||||
titleTextStyle: _titleTextStyle,
|
||||
@ -217,6 +220,32 @@ class _SettingsViewState extends State<SettingsView> {
|
||||
)
|
||||
],
|
||||
),
|
||||
SettingsSection(
|
||||
title: 'Info',
|
||||
titleTextStyle: _titleTextStyle,
|
||||
tiles: <SettingsTile>[
|
||||
SettingsTile(
|
||||
leading: const Icon(Icons.info),
|
||||
title: 'About',
|
||||
onPressed: (c) =>
|
||||
Navigator.pushNamed(context, Routes.about),
|
||||
),
|
||||
SettingsTile(
|
||||
leading: Image.asset(
|
||||
'assets/images/logo/logo_icon_transparent_green.png',
|
||||
width: 30,
|
||||
),
|
||||
title: 'Jisho',
|
||||
onPressed: (c) => open_webpage('https://jisho.org/about'),
|
||||
),
|
||||
SettingsTile(
|
||||
leading: const Icon(Icons.copyright),
|
||||
title: 'Licenses',
|
||||
onPressed: (c) =>
|
||||
Navigator.pushNamed(context, Routes.aboutLicenses),
|
||||
),
|
||||
],
|
||||
)
|
||||
],
|
||||
);
|
||||
},
|
||||
|
||||
10
lib/services/open_webpage.dart
Normal file
10
lib/services/open_webpage.dart
Normal file
@ -0,0 +1,10 @@
|
||||
import 'package:flutter/material.dart';
|
||||
import 'package:url_launcher/url_launcher.dart';
|
||||
|
||||
Future<void> open_webpage(String url) async {
|
||||
if (await canLaunch(url)) {
|
||||
launch(url);
|
||||
} else {
|
||||
debugPrint('Could not open url: $url');
|
||||
}
|
||||
}
|
||||
@ -39,6 +39,8 @@ extension Methods on JapaneseFont {
|
||||
'';
|
||||
}
|
||||
|
||||
const String appVersion = '0.1 Beta';
|
||||
|
||||
const Map<String, dynamic> _defaults = {
|
||||
'romajiEnabled': false,
|
||||
'extensiveSearch': true,
|
||||
|
||||
@ -44,11 +44,11 @@ flutter:
|
||||
uses-material-design: true
|
||||
|
||||
assets:
|
||||
- assets/
|
||||
- assets/fonts/
|
||||
- assets/images/
|
||||
- assets/images/logo/
|
||||
# - images/a_dot_burr.jpeg
|
||||
# - images/a_dot_ham.jpeg
|
||||
- assets/licenses/
|
||||
|
||||
|
||||
fonts:
|
||||
|
||||
Loading…
Reference in New Issue
Block a user