Skip to content

Latest commit

 

History

History
144 lines (95 loc) · 6 KB

README.md

File metadata and controls

144 lines (95 loc) · 6 KB
Raw

paranext-core

Electron client, extension host, and C# library for Paranext

Build Status CodeQL Github Tag

Users

This software is not yet ready for users. We'll update here with where you can install it when its ready.

Linux Users

To use .AppImage files in Linux, install FUSE (you only need to do this once), for example, on Ubuntu (>= 22.04):

sudo apt install libfuse2

Then simply execute/run the .AppImage file, which you can download from Releases.

Developer Install

Set up pre-requisites for building:

Linux Development Pre-requisites

Add the system libraries needed for Electron, Build Instructions (Linux).

All Platforms Development Pre-requisites

Install dotnet .NET 7 SDK from here.

To check if dotnet is installed run (ensure you have a v7 SDK):

dotnet --version
dotnet --list-sdks

Cloning and installing dependencies (all platforms)

Clone the repo and install dependencies:

git clone https://github.com/paranext/paranext-core.git
cd paranext-core
npm install

Starting Development

Start the app in the dev environment:

npm start

After you run npm start (or, in VSCode, launch Debug Paranext Core), you can edit the code, and the relevant processes will hot reload.

Packaging for Production

To package apps for the local platform:

npm run package

Publishing

  1. Create a branch of the form release/*, e.g. release/v1.2.3, or release/v1.2.3-rc1.
  2. Update the version in your project's release/app/package.json file (e.g. 1.2.3).
  3. Run npm i in that folder to update its package-lock.json.
  4. Create a new draft GitHub Release, ensure the following are included:
    • a Tag version, e.g. v1.2.3, choose Create new tag on publish.
    • set the Target to the release branch.
    • a copy of the change log. Click Generate release notes as a starting point.
    • Click Save draft.
  5. Update CHANGELOG.md with changes in this release from the GitHub draft Release.
  6. Commit these changes to your release branch and push the commit to GitHub.
  7. Once the GitHub build Action has finished, it will add build artifact files to the draft release. Remove the .blockmap files and leave the .yml files and the installers and executable, e.g. .exe on Windows.
  8. Publish the release on GitHub.
  9. Merge the release branch back into main with a merge commit.

Windows Development with WSL2

On Windows, you can install WSL (Windows Subsystem for Linux) so you can test cross-platform compatibility on Linux (as well as Windows). You'll need to use a Linux distribution with WSL2 (rather than WSL1) so the X-Server windows can be opened for Electron.

  1. Here is how to install Linux on Windows with WSL.
  2. You'll want to follow that by setting up to use VS Code, Git and NodeJS with WSL. See the various tutorials.
  3. In the WSL distribution, add system libraries needed for Electron, see Linux Development Pre-requisites above.
  4. In the WSL distribution, clone the repo as described above under Developer Install.

You'll be running a copy of the repo in both Windows and WSL so make sure they are both up-to-date.

You can use VS Code from your host to access code in your WSL repo clone using the Microsoft Remote Development VS Code extension.

VS Code Extension Options

Extensions highly recommended for this repo are already displayed in VS Code through the Extensions Recommendations settings. These are optional extensions that our developers enjoy using:

Formatting and Linting

Formatting happens automatically when you commit. If you use VS Code with this repo's recommended extensions it will format when you save.

To check TypeScript for readability, maintainability, and functionality errors, and to check a few other files for proper formatting, run the following from the repo root (or just use VS Code with this repo's recommended extensions)

npm run prettier
npm run lint

To check C# for readability, maintainability, and functionality errors, run the following from the repo root (or just use VS Code with this repo's recommended extensions)

cd c-sharp
dotnet tool restore
dotnet csharpier .

License

MIT © SIL International