README.md 2.76 KB
Newer Older
1
# Tungsten
Tatsuoki, Takayuki's avatar
Tatsuoki, Takayuki committed
2

3
[Japanese version](https://gitlab.com/tatsuokitakayuki/tungsten/-/blob/master/README-JP.md)
Tatsuoki, Takayuki's avatar
Tatsuoki, Takayuki committed
4

Tatsuoki, Takayuki's avatar
Tatsuoki, Takayuki committed
5 6
[![pas](https://img.shields.io/static/v1?&message=ProgressiveApp.Store&color=74b9ff&style=flat&label=Follow%20Tungsten%20at)](https://progressiveapp.store/pwa/Tungsten)

Tatsuoki, Takayuki's avatar
Tatsuoki, Takayuki committed
7
## What is this
Tatsuoki, Takayuki's avatar
Tatsuoki, Takayuki committed
8

9 10 11
Tungsten is an application that edits text and code, which is implemented only by Web technologies (HTML, CSS, and JavaScript).
A Web App that can be installed offline on a device like Tungsten is called a Progressive Web Application (PWA).
We are developing Tungsten mainly for Chromebook (or Chromium OS and its based OS) users.
Tatsuoki, Takayuki's avatar
Tatsuoki, Takayuki committed
12

Tatsuoki, Takayuki's avatar
Tatsuoki, Takayuki committed
13
## Project goals
Tatsuoki, Takayuki's avatar
Tatsuoki, Takayuki committed
14

15
- Make Tungsten a practical text code editor.
Tatsuoki, Takayuki's avatar
Tatsuoki, Takayuki committed
16
    - Add functionality.
Tatsuoki, Takayuki's avatar
Tatsuoki, Takayuki committed
17 18
    - Fix the defect.
    - Maintain.
Tatsuoki, Takayuki's avatar
Tatsuoki, Takayuki committed
19

20
## Features of Tungsten
Tatsuoki, Takayuki's avatar
Tatsuoki, Takayuki committed
21 22 23

- It is a progressive web app.
- Works offline.
Tatsuoki, Takayuki's avatar
Tatsuoki, Takayuki committed
24 25
    - A network connection is required only during background automatic update processing.
- All processing is done in the browser of the device.
Tatsuoki, Takayuki's avatar
Tatsuoki, Takayuki committed
26
- It supports "File system access API" for reading and writing files in local storage.
Tatsuoki, Takayuki's avatar
Tatsuoki, Takayuki committed
27 28
- Do not use cookies.
- Open source software.
Tatsuoki, Takayuki's avatar
Tatsuoki, Takayuki committed
29

30
## Disadvantages of Tungsten
Tatsuoki, Takayuki's avatar
Tatsuoki, Takayuki committed
31

Tatsuoki, Takayuki's avatar
Tatsuoki, Takayuki committed
32 33
- The save function is supported only by some browsers.
    - For browsers that do not support the save function, use the download function instead.
Tatsuoki, Takayuki's avatar
Tatsuoki, Takayuki committed
34

Tatsuoki, Takayuki's avatar
Tatsuoki, Takayuki committed
35
## System requirements
Tatsuoki, Takayuki's avatar
Tatsuoki, Takayuki committed
36

Tatsuoki, Takayuki's avatar
Tatsuoki, Takayuki committed
37 38 39 40 41 42 43 44 45
- OS
    - Chrome OS (Main target, Tested)
    - Linux (Reported to work)
    - Windows (Tested)
    - Mac
    - Android (Tested, but unstable)
    - iOS
    - iPadOS
- Browser
46 47 48 49
    - Chrome (Version 63 or higher, Main target, Tested)
    - Firefox (Version 67 or higher)
    - Edge (Version 79 or higher)
    - Safari (Version 11.1 or higher)
Tatsuoki, Takayuki's avatar
Tatsuoki, Takayuki committed
50

51
## List of libraries and frameworks used
Tatsuoki, Takayuki's avatar
Tatsuoki, Takayuki committed
52

53 54 55 56 57
* [Ace](https://ace.c9.io/)
* [Material Design Component for Web](https://material.io/develop/web/)
* [Material Design Icons](https://google.github.io/material-design-icons/)
* [localForage](https://localforage.github.io/localForage/)
* [emmet-core](https://github.com/cloud9ide/emmet-core)
Tatsuoki, Takayuki's avatar
Tatsuoki, Takayuki committed
58

59
## License
Tatsuoki, Takayuki's avatar
Tatsuoki, Takayuki committed
60

61
This program is open source software; it is distributed under the [MIT License](https://gitlab.com/tatsuokitakayuki/tungsten/-/blob/master/LICENSE).
Tatsuoki, Takayuki's avatar
Tatsuoki, Takayuki committed
62 63

## How to use
Tatsuoki, Takayuki's avatar
Tatsuoki, Takayuki committed
64

Tatsuoki, Takayuki's avatar
Tatsuoki, Takayuki committed
65
### How to try immediately
Tatsuoki, Takayuki's avatar
Tatsuoki, Takayuki committed
66

67 68
- [stable](https://tungsten.kirari.app/)
- [dev](https://tungsten.kirari.dev/)
Tatsuoki, Takayuki's avatar
Tatsuoki, Takayuki committed
69 70 71
    - This app uses [Firebase](https://firebase.google.com/) hosting services.

### How to try locally
Tatsuoki, Takayuki's avatar
Tatsuoki, Takayuki committed
72

Tatsuoki, Takayuki's avatar
Tatsuoki, Takayuki committed
73
1. Clone this repository.
74
    - `git clone https://gitlab.com/tatsuokitakayuki/tungsten.git`
Tatsuoki, Takayuki's avatar
Tatsuoki, Takayuki committed
75
2. Change to the public directory.
76
    - `cd tungsten/public/`
Tatsuoki, Takayuki's avatar
Tatsuoki, Takayuki committed
77
3. Start the HTTP server.
78
    - `python3 -m http.server --bind 127.0.0.1 8080`
Tatsuoki, Takayuki's avatar
Tatsuoki, Takayuki committed
79 80 81
4. Open localhost:8080 in your web browser.

Please try.
Tatsuoki, Takayuki's avatar
Tatsuoki, Takayuki committed
82 83

## Contact information
Tatsuoki, Takayuki's avatar
Tatsuoki, Takayuki committed
84 85 86 87 88 89

* 龍興 尚幸 (Tatsuoki, Takayuki): Project leader
    - Twitter: @ttatsuoki
    - e-mail: takayuki.tatsuoki@gmail.com

Feel free to.