Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
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 2 months ago
JSON representation
Visualisez et améliorez vos arborescences de fichiers !
- Host: GitHub
- URL: https://github.com/SocialGouv/archifiltre-docs
- Owner: SocialGouv
- License: apache-2.0
- Created: 2019-06-18T14:43:26.000Z (over 5 years ago)
- Default Branch: dev
- Last Pushed: 2024-04-10T21:21:04.000Z (9 months ago)
- Last Synced: 2024-04-13T20:33:03.535Z (9 months ago)
- Topics: electron, material-ui, react, redux, typescript
- Language: TypeScript
- Homepage: https://archifiltre.fr/docs
- Size: 21.4 MB
- Stars: 42
- Watchers: 9
- Forks: 8
- Open Issues: 33
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
Docs par Archifiltre
Docs by Archifiltre allows you to visualize and improve your file trees. Learn more about it [here](https://archifiltre.fabrique.social.gouv.fr/).
## 🚀 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)