To get started with LunaSea development on any platform, you will need to ensure the following tools are installed:

1. Flutter

2. Node.js (v14+)

Flutter

To validate Flutter's installation, please ensure that flutter doctor -v does not return any issues with your current installation.

Node.js

LunaSea uses Node.js for installing Git Hooks for the repository and for helper scripts. While it is not necessary to install Node.js for development, it will ensure you follow the required commit message format and give access to scripts that can be helpful for development.

In order to create any builds for LunaSea, you must first create and attach a Development Certificate to the XCode project.

Preparing the Project

In the root of the project, enter the macos folder and open Runner.xcworkspace in XCode.

1. Select Runner in the lefthand navigation pane

2. Under Targets select Runner

3. Select the Signing & Capabilities tab

Creating a Signing Team

1. Under Signing select the dropdown for the team (Should currently be Unknown Name (<<My Team ID>>)

2. Add an account (your Apple ID) and select your name or if already added then simply select your name

3. The status should show Failed to register bundle identifier because the bundle identifier needs to be unique for each profile

Creating a Bundle Identifier and Signing Profile

1. Enter a unique bundle identifier (this does not need to resemble the current bundle identifier, it can be anything you want, but should follow the format of <word>.<word>.<word>, so for example I have used app.lunasea.testprofile

2. Once you enter a unique bundle identifier, hit "Try again" to fetch a new signing profile for this bundle identifier. You will see the Apple Development: <Your email> if you successfully created a signing profile

And that's it! You are ready to create builds of LunaSea using your own signing profile.

In order to create any builds for LunaSea, you must first create and attach a Development Certificate to the XCode project.

Preparing the Project

In the root of the project, enter the ios folder and open Runner.xcworkspace in XCode.

1. Select Runner in the lefthand navigation pane

2. Under Targets select Runner

3. Select the Signing & Capabilities tab

Creating a Signing Team

1. Under Signing select the dropdown for the team (Should currently be Unknown Name (<<My Team ID>>)

2. Add an account (your Apple ID) and select your name or if already added then simply select your name

3. The status should show Failed to register bundle identifier because the bundle identifier needs to be unique for each profile

Creating a Bundle Identifier and Signing Profile

1. Enter a unique bundle identifier (this does not need to resemble the current bundle identifier, it can be anything you want, but should follow the format of <word>.<word>.<word>, so for example I have used app.lunasea.testprofile

2. Once you enter a unique bundle identifier, hit "Try again" to fetch a new signing profile for this bundle identifier. You will see the Apple Development: <Your email> if you successfully created a signing profile

And that's it! You are ready to create builds of LunaSea using your own signing profile.

In order to create production builds for LunaSea, you must first create and sign the release using the .

Create a Keystore

Open a terminal window and run the following command to generate a new Android keystore:

You can optionally change the following:

1. -keystore ~/key.jks: By default this will create the new keystore in the home directory of the running user as the file key.jks but this can be changed to any location you like

2. -alias lunasea: By default the keystore internal alias is set to lunasea but you can use any alias you like

The generation will ask you for some basic information including a password. Please ensure you do not forget this password because you will need it in the next step.

Add the Keystore Information to LunaSea

In the root of the project, enter the android folder and copy your previously generated *.jks keystone into this folder, and name it key.jks.

In the same folder, open key.properties.sample. Fill in all of the fields with the following information:

1. storePassword: Password from step 1

2. keyPassword: Same password from step 1

3. keyAlias: The chosen alias from step 1

4. storeFile: Keep it as ../key.jks

Save the file as key.properties inside of <project root>/android.

And that's it! You are ready to create production releases of LunaSea using your own signing keystore.