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
The codebase is built using nodejs >=16.13.x
, and uses yarn (version 3.1.1
) to manage its dependencies.
The project structure is based on Vite Electron Builder Boilerplate but it was changed to incorporate react and mobx-state-tree.
After installing node
, you can install yarn
with
npm i -g yarn
To start working, install all dependencies with
yarn install --immutable
If TypeScript complains about missing type definitions, run
yarn types
To start a development instance of Sophie, which will reload on source changes, run
yarn watch
To run all the tests, run
yarn test
or to automatically rerun tests for changed source files, run
yarn watch:test
To build the application in release mode, run
yarn compile
To typecheck the project, run
yarn typecheck
To run the linter, run
yarn lint
License
Copyright (C) 2021-2022 Kristóf Marussy <kristof@marussy.com>
Copyright (C) 2022 Vijay A <vraravam@users.noreply.github.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/>.