aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: b27e993a36fd3e4252a7e5b8f2fa80f505021070 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
# Faunerie
A browser and search engine for local copies of various image boards (e621, Derpibooru, Furbooru, ...)

## Development
Assuming you are using macOS, Windows or Linux. Other POSIX systems won't work as Electron does not have binaries for these.

### Cloning
```
git clone https://github.com/equestria-dev/faunerie
```

### Setup
```
# Note: this will install TypeScript globally
npm install
```

### Running
```
# For the app itself:
npm run debug

# For the updater:
npm run debug-updater
```

### Building
```
# This will run 'npm audit fix' and 'npm install' to update dependencies if needed
npm run release-unix  # For Unix systems
npm run release-win   # For Windows
```