Repository files navigation

Website:https://phcode.io

Phoenix is a modern open-source andfree software text editordesigned to make coding as simple and fun as playing a video game.

1. Targeted for web development. Js, html and CSS enjoy special status.
2. Game UX - Approach code editing like a game that a school kid would play after skipping the tutorial.
3. Light-weight editor.
4. Extension support maintaining full compatibility with Brackets extensions (except brackets-node extensions).
5. Uncompromised local development experience.
6. Support for pluggable remote back-ends.
7. Phoenix core will work from a static web server.
8. Source code in release builds will always be auditable and readable from dev-tools.

AGPL/Libre license guards your right to audit and change code that handles your data.Phoenix usually loads up in under one second and loading it faster at the expense of making it hardto read and develop is a noop. We prioritize simplicity and eaze of development.

• Get in touch with our community.
• Request a new feature
• Join our Discord community
• Raise issues
• Contribute

Source Repository

• Install gulp globally once.
  • In Mac/Linux:sudo npm install -g gulp-cli
  • In Windows:npm install -g gulp-cli
• runnpm install
• To build after npm install:
  • npm run build - generate builds close to release builds locally.
  • ornpm run build:debug to build debug builds for development with more debug symbols.

• runnpm run serve in the terminal.
• Use chrome/edge browser to navigate tohttp://localhost:8000/src

SonarLint static code analysis checker is not yet available as a Bracketsextension. Use sonarLint plugin for webstorm or any of the availableIDEs from this link before raising a pull request:https://www.sonarlint.org/

• runnpm install
• To build the release artifacts, run one of the following commands depending on what build you want:
  • npm run release:dev,npm run release:staging,npm run release:prod
• The release artifacts to host will be indist folder.

This is the easiest and preferred way to run Phoenix tests.

• runnpm run build in the terminal.
  • NB: this will setup all the required files for test
• Use chrome/edge browser to navigate to Phoenixhttp://localhost:8000/src/index.html
• In Phoenix Menu, selectDebug > Phoenix Code Diagnostic Tools > Run Phoenix Code Tests To open the test runner.
• Run tests as required.
  • NB: To reset test data files, click onreset and reload tests option in the test runner.
• You can use the browser dev tools to debug.

We usePlaywright to run the headless version of our tests.Please note that we do not use Playwright as our actual test framework, but as a headless browser(chrome and firefox)to run our tests written in Jasmine/Mocha.

• runnpm run test<*> in the terminal to run the unit tests run in GitHub actions. Eg.npm run testChromium.
• To debug the tests,npm run test<*>Debug. Eg.npm run testFirefoxDebug. However, we recommend using theaboveRunning tests in browser section to actually fix/debug tests that are failing in the pipeline.It has much better debug UX and fixing it directly in the browser will almost certainly fix it in playwright.
• To run integration tests use command:npx cross-env TEST_ENV=<integration suite name> npm run test<*>
  • The allowed integration test suite names are:integration, LegacyInteg, mainview, livepreview.You can get these suite names from the test runner.
  • Eg:npx cross-env TEST_ENV=integration npm run testChromium
• To debug integration tests use command: npx cross-env TEST_ENV=<integration suite name> npm run test<*>Debug
  • Eg:npx cross-env TEST_ENV=mainview npm run testChromiumDebug

1. Build the release usingnpm run release:<stage>. Eg:npm run release:dev
2. Run the unit tests using format:npm run test<*>Dist. Eg.npm run testChromiumDist.
3. Run the integration tests using the format:npx cross-env TEST_ENV=<integration suite name> npm run test<*>Dist. Eg.npx cross-env TEST_ENV=mainview npm run testChromiumDist.

• dev:https://dev.phcode.dev/test/SpecRunner.html
• staging:https://staging.phcode.dev/test/SpecRunner.html
• prod:https://phcode.dev/test/SpecRunner.html

To view/edit the files in the browser virtual file system in Phoenix:debug menu> Open Virtual File System

• clean builds only:npm run clean

One a pull request is merged, it will be automatically deployed to dev.phcode.dev . To view the changes:

1. gotohttps://dev.phcode.dev/devEnable.html and clickenable dev.phcode.dev . only needs to be done once.
2. gotohttps://dev.phcode.dev to preview your changes. If it is a recent change, you might need to wait forup to 15 minutes before the changes are deployed to the dev stage. Reload page a few times to get the latestdev build and reset cached content.

The process is the same forstaging.phcode.dev. Builds that are verified in development will be pushedperiodically to staging. To view staging:

1. gotohttps://staging.phcode.dev/devEnable.html and clickenable staging.phcode.dev . only needs to be done once.
2. gotohttps://staging.phcode.dev to preview your changes. If it is a recent change, you might need to wait forup to 15 minutes before the changes are deployed to the dev stage. Reload page a few times to get the latestdev build and reset cached content.

• All changes pushed to the main branch are automatically published tohttps://dev.phcode.dev
• To publish the changes tohttps://staging.phcode.dev , push changes to thestaging branch in this repo with a pull request.
• Once the changes are validated and tested, trigger a prod deployment by pushing to theprod branch.

• Phoenix is based on the Brackets code editor by Adobe. Find out more onAdobe Brackets here.
• Our main code editor libraryhttps://codemirror.net/
• Inspired by previous work from theMozilla Thimble project to port brackets to the web.https://github.com/mozilla/brackets
• In browser server based onnohost byhttps://github.com/humphd/

Discussion:#184

GNU AGPL-3.0 License

Copyright (c) 2021 - present Core.ai

Based on Backets, Copyright (c) 2012 Adobe Systems Incorporated and the brackets.io community

This program is free software: you can redistribute it and/or modifyit under the terms of the GNU Affero General Public License aspublished by the Free Software Foundation, either version 3 of theLicense, 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 ofMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See theGNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public Licensealong with this program. If not, seehttps://opensource.org/licenses/AGPL-3.0.