Skip to content

CONTRIBUTION.md

Latest commit

 

History

History
74 lines (49 loc) · 2.29 KB

CONTRIBUTION.md

File metadata and controls

74 lines (49 loc) · 2.29 KB

Project Structure

General

This repository is a mono-repo that is currently focused on the development of the Rewind desktop application. However, as we are working with web technologies (WebGL, JS), there are also plans to implement a Rewind web version.

This mono-repo is powered by the nx build system.

In apps you will find the applications - every folder corresponds to one "product".

In libs you will find the common code that is shared across all the applications.

In tests you will find the integration tests that will test the correctness of the libraries. Generally speaking, tests that have some external dependencies (such as a beatmap or replay file) will belong here. Unit tests should be written in the corresponding library src folder with *.spec.ts filename extension.

Familiarity with Electron's process model required.

Setup

Basics

Install the following:

  • Latest Node.js LTS version (e.g. nvm install --lts)
  • git-lfs for the test data in testdata/

When changes have been done to some submodules, you need to merge them as follows:

git submodule update --remote --merge

Building

yarn install
yarn run build

Developing

First start the desktop-frontend to expose the frontend on port 4200 with "Hot Reloading" enabled.

yarn run desktop-frontend:dev

Then start the Electron application:

yarn run desktop-main:dev

If you make a change in the desktop-main package, you will need to rerun the command above again.

Releasing

When you want to create a new release, follow these steps:

  1. Update the version in your project's package.json file (e.g. 1.2.3)
  2. Commit that change (git commit -am v1.2.3)
  3. Tag your commit (git tag v1.2.3). Make sure your tag name's format is v*.*.*. Your workflow will use this tag to detect when to create a release
  4. Push your changes to GitHub (git push && git push --tags)

After building successfully, the action will publish your release artifacts. By default, a new release draft will be created on GitHub with download links for your app. If you want to change this behavior, have a look at the electron-builder docs.