Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/socialgouv/archifiltre-docs

Visualisez et améliorez vos arborescences de fichiers !
https://github.com/socialgouv/archifiltre-docs

electron material-ui react redux typescript

Last synced: about 13 hours ago
JSON representation

Visualisez et améliorez vos arborescences de fichiers !

Awesome Lists containing this project

README

        


Docs par Archifiltre


Github Main CI Status
CodeQL Status
License: Apache-2.0
Npm version
codecov
codegouv


Docs by Archifiltre allows you to visualize and improve your file trees. Learn more about it [here](https://archifiltre.fabrique.social.gouv.fr/).

![Presentation](docs/presentation.png)

## 🚀 Launch the app

First install the dependencies

```bash
yarn
```

Then copy the dist env file

```bash
cp .env.dist .env
```

(Optional) Instal react devtools

```bash
yarn devtools
```

You should use auto reloading when developing, using

```bash
yarn dev
```

and then, reload your electron app with the refresh command (`CMD + R` on MacOS)

You can make the app automatically load a specific folder by doing:

```bash
AUTOLOAD="/absolute/or/relative/path/to/folder" yarn dev
```

You can automatically reload the previous session using :

```bash
AUTORELOAD=true yarn dev
```

(this envs can also be set in env file)

## ✨ Contributing

To contribute, see more [here](CONTRIBUTING.md)

To know more about the project architecture, go [here](docs/README.md)

## 📝 Import script

Docs provides you with an export script that you can run directly on your file server. To know more about it, go [here](scripts/README.md)