Phoenix Desktop
This repo deals with Windows, Mac and Linux Desktop builds of Phoenix Code Editor.Please see https://github.com/phcode-dev/phoenix on how to Contribute or get in touch with the community.
Status
Experimental development- Work in progress, Track status here: https://github.com/orgs/phcode-dev/projects/1/views/1Development Setup
We use Tauri as our app shell. We maintain the phcode-tauri-shell and phcode static website code in two separate repositories. This separation is intended to simplify development by distinctly isolating the shell and phcode. For instance, if you are solely developing the shell internals, you can always construct an empty tauri app without having to build phoenix.Follow the below instructions to set up development environment.
Prerequisites
- Setup node and npm 16+.
- Setup tauri prerequisites for your platform.
- Setup Install gulp globally once with
npm install -g gulp-cli(usesudo npm install -g gulp-cliin *nix systems)
Get the code for development
Get phoenix and phoenix-desktop into two folders in your computer.git clone https://github.com/phcode-dev/phoenix-desktop.git
git clone https://github.com/phcode-dev/phoenix.git_IMPORTANT:_phoenixandphoenix-desktopshould be within the same parent directory!!!
Running Phoenix Desktop Development Builds
For development, tauri will directly load the phcode static server url "localhost:8000/src" from the phoenix repo. So you can quickly iterate changes without rebuilding tauri src for each change. Just a simple reload will suffice.- Setup and run
phoenixby following the steps.
cd phoenix
npm install
npm run build
npm run serve- To build desktop development build after starting phoenix server:
cd phoenix-desktop
npm install
npm run serve- Now you can make changes to phoenix and phoenix-desktop independently and see changes live.
phoenix-desktop folder built with Tauri will be auto compiled and live patched on save.
* To load changes in phoenix folder, just reload Phoenix by pressing f5 in the Phoenix window just like you would do on the browser versions of Phoenix.
Building release binaries locally for development/testing
Note: For the majority of development tasks, it's not necessary to build the release artifacts locally,
as outlined in this section. Most development requirements can be met by simply following the instructions
provided in the Running Phoenix Desktop Development Builds section.
This process is mainly required when you want to test something specific that might behave differently under the tauri:// protocol.
Tauri development builds load phcode from https:// url. But the release build uses packaged assets with custom tauri url
tauri://. So there may be some cases where the behavior is different between the release builds and development builds.
_IMPORTANT:_phoenixandphoenix-desktopprojects should be within the same parent directory for the below commands to work!!!
generate release builds from the phoenix/src folder
If you want to generate the release builds locally directly while you are editing the phoenix/src folder, run the following command.
cd phoenix-desktop
To generate debug builds:
npm run releaseSrc
OR to generate debug builds, just run npm run releaseSrcDebug
generate dev, staging and prod release builds from phoenix/dist folder
These builds are faithful to the actual binaries that are generated from the github CI pipelines shipped to users.
If you want to generate the dev, staging and prod builds locally of phcode, run the following command:
# You should first build the appropriate release build in phoenix.
cd phoenix
npm install
npm run build
npm run release:prod
Other release options are npm run release:dev and npm run release:staging
Now generate the tauri release builds:
cd ../phoenix-desktop
npm run releaseDist
OR to debug, just run npm run releaseDistDebug
Generating installers/AppImage and DMGs locally from phoenix/dist folder
To generate the installers, use the commands
# You should first build the appropriate release build in phoenix.
cd phoenix
npm install
npm run build
npm run release:prod
Other release options are npm run release:dev and npm run release:staging
Now generate the bundles
cd ../phoenix-desktop
npm run releaseDistBundle
will generate appimages/DMGs or nsix windows installers in target/release/bundle
Building release binaries and installers in GitHub actions
The npm commands that begin with_ci-* are exclusively designed to execute in a GitHub Actions environment.
These commands are not typically executed on your local machine unless you're actively working on the GitHub
Actions workflows. However, if you need to run these locally for testing, look for #uncomment_line_for_local_build_1
in the codebase and uncomment the corresponding line.
NB: Make sure not to check in any artists created by the build process!!!
Primary GitHub Actions Targets
There are three primary targets for our GitHub actions:npm run _ci-release:prodnpm run _ci-release:devnpm run _ci-release:staging
# Example on how to run the ci-release script locally.
cd phoenix-desktop
npm install
npm run _ci-release:prod
npm run tauri build --debug
or if you want the release builds, use npm run tauri build
Execution Workflow
The script will begin by cloning the repository identified in thephoenixRepo section of the package.json file.
Next, it will build the corresponding stage as specified in the npm run _ci-release: command and will
generate the necessary distribution folders in phoenix/dist. Following this, it will patch the Tauri configuration files
to use the generated distribution folder for creating the release builds.
The actual release artifacts will then be built by the tauri action tauri-apps/tauri-action@v0 specified in the
tauri-build.yml file. Finally, it will generate a draft release.
Remember, the npm run _ci-* commands are designed to execute in the GitHub Actions environment.
They're not typically used for local machine executions unless you're working on or testing the GitHub Actions workflows themselves.
Building the demo app
If you dont want to build phcode and just build a demo app with similar config as phcode(You may do this if you are working on the release generation or build tooling and don't want to wait for phcode to build every time you want to test the build). Just run this command:npm run tauriBuildDemoAppLicense
GNU AGPL-3.0 License
Copyright (c) 2022 - present Core.ai
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, either version 3 of the License, or (at your option) any later version.
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://opensource.org/licenses/AGPL-3.0.