blob: 122ac1e1941dfa2b33a4b1ad61842942eff5f52b (
plain) (
blame)
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
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
|
# Sophie
_Messaging app built from the ground up with security in mind_
This is currently a work in progress, you should probably check back later.
## Development
This project uses [yarn](https://yarnpkg.com/) to manage its dependencies.
The project structure is based on [Vite Electron Builder Boilerplace](https://github.com/cawa-93/vite-electron-builder) but it was changed to incorporate [react](https://reactjs.org/) and [mobx-state-tree](https://github.com/mobxjs/mobx-state-tree).
To start working, install all dependencies with
``` sh
yarn install
```
To start a development instance of Sophie, which will reload on source changes, run
``` sh
yarn watch
```
To run all the tests, run
```sh
yarn test
```
or to automatically rerun tests for changed source files, run
```sh
yarn watch:test
```
To build the application in release mode, run
``` sh
yarn compile
```
If TypeScript complains about missing type definitions, or you want to typecheck the project, run
```sh
yarn typecheck
```
## License
> Copyright (C) 2021-2022 Kristóf Marussy <kristof@marussy.com>
>
> This program is free software: you can redistribute it and/or modify
> it under the terms of the GNU Affero General Public License as
> published by the Free Software Foundation, version 3.
>
> This program is distributed in the hope that it will be useful,
> but WITHOUT ANY WARRANTY; without even the implied warranty of
> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
> GNU Affero General Public License for more details.
> You should have received a copy of the GNU Affero General Public License
> along with this program. If not, see <[https://www.gnu.org/licenses/](https://www.gnu.org/licenses/)>.
|
