1 |
|
2 | [![Stand With Ukraine](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/badges/StandWithUkraine.svg)](https://vshymanskyy.github.io/StandWithUkraine)
|
3 | [![Русский корабль, иди на хуй!](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/badges/RussianWarship.svg)](https://vshymanskyy.github.io/StandWithUkraine)
|
4 | [![Stand With Ukraine](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/banner2-direct.svg)](https://vshymanskyy.github.io/StandWithUkraine/)
|
5 |
|
6 | [![CI](https://github.com/farjs/farjs/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/farjs/farjs/actions/workflows/ci.yml?query=workflow%3Aci+branch%3Amain)
|
7 | [![Coverage Status](https://coveralls.io/repos/github/farjs/farjs/badge.svg?branch=main)](https://coveralls.io/github/farjs/farjs?branch=main)
|
8 | [![npm version](https://img.shields.io/npm/v/farjs-app)](https://www.npmjs.com/package/farjs-app)
|
9 | [![Downloads](https://img.shields.io/npm/dm/farjs-app.svg)](https://www.pkgstats.com/pkg:farjs-app)
|
10 | [![Publish Size](https://badgen.net/packagephobia/publish/farjs-app)](https://packagephobia.com/result?p=farjs-app)
|
11 | [![Install Size](https://badgen.net/packagephobia/install/farjs-app)](https://packagephobia.com/result?p=farjs-app)
|
12 |
|
13 | ## FAR.js
|
14 |
|
15 | Good old Windows **F**ile and **AR**chive Manager
|
16 | ([FAR](https://en.wikipedia.org/wiki/Far_Manager)) app built with:
|
17 | [React.js](https://reactjs.org/),
|
18 | [react-blessed](https://github.com/Yomguithereal/react-blessed),
|
19 | [blessed](https://github.com/chjj/blessed)
|
20 |
|
21 | Runs on [Node.js](https://nodejs.org/) and [bun](https://bun.sh) on different platforms:
|
22 | * `Mac OS X` (primary support in [iTerm2](https://iterm2.com/) and [WezTerm](https://wezfurlong.org/wezterm/))
|
23 | * `Windows` (primary support in [WezTerm](https://wezfurlong.org/wezterm/) and [Windows Terminal](https://docs.microsoft.com/en-us/windows/terminal/))
|
24 | * `Linux` (primary support in [WezTerm](https://wezfurlong.org/wezterm/))
|
25 |
|
26 | ## Install
|
27 |
|
28 | To install (or upgrade) it on your computer use the following command:
|
29 | ``` bash
|
30 | npm i -g farjs-app
|
31 | ```
|
32 |
|
33 | then you can run the application (using node) from your favorite terminal:
|
34 | ``` bash
|
35 | farjs
|
36 | ```
|
37 |
|
38 | To run using [bun](https://bun.sh) use:
|
39 | ``` bash
|
40 | bun $(which farjs)
|
41 | ```
|
42 |
|
43 | ![Screenshots](https://raw.githubusercontent.com/farjs/farjs/main/docs/images/screenshots.png)
|
44 |
|
45 | ## Documentation
|
46 |
|
47 | Please, visit [FAR.js](https://farjs.github.io) web-site
|
48 | for the full documentation.
|
49 |
|
50 | ## Contributing
|
51 |
|
52 | See [develop.md](https://github.com/farjs/farjs/blob/main/develop.md)
|