README.md

Welcome to Phoenix!

Website: https://phcode.dev

Phoenix is a modern open-source and free code editor for the web, built for the browser.

Code Guardian

Phoenix is in early alpha.

• Please subscribe to our notification list to get notified when Phoenix goes live.

Tenets

1. Targeted for web development. Js, html and CSS enjoy special status.
2. Light-weight editor.
3. Extension support maintaining full compatibility with Brackets extensions (except brackets-node extensions).
4. Uncompromised local development experience.
5. Support for pluggable remote back-ends.
6. Phoenix core will work from a static web server.
7. No minification/compilation step or code obfuscation of release builds for code auditability and readability.

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 hard to read and develop is a noop. We prioritize simplicity and eaze of development.

Status

Phoenix is in alpha and is under active development.

• Phoenix Alpha development status.

Contributing/ Feedback

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

Building Phoenix

Source Repository

• Install gulp globally once. npm install -g gulp-cli (use sudo in *nix systems)
• run npm install
• To build after npm install: npm run build

Running phoenix

• run npm run serve in the terminal.
  • NB: To test Phoenix from an external mobile or machine, use npm run serveExternal instead of serve
• Use chrome/edge browser to navigate to http://127.0.0.1:8000/

IDE Setup

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

Building Release artifacts

• run npm install
• To build the release artifacts: npm run release
• The release artifacts to host will be in dist folder.

Running tests

• run npm run test 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, select Debug > run Tests To open the test runner.
• Run tests as required.
  • NB: To reset test data files, click on reset and reload tests option in the test runner.

Browsing the virtual file system

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

Clean and reset builds

• clean builds only: npm run clean
• Reset everything including node modules: npm run reset

Deployment to phcore.dev

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

Note: Pre-prod is still work in progress.

Acknowledgements

• Phoenix is based on the Brackets code editor by Adobe. Find out more on Adobe Brackets here.
• Inspired by previous work from the Mozilla Thimble project to port brackets to the web. https://github.com/mozilla/brackets
• In browser server based on nohost by https://github.com/humphd/

License

Discussion: phcode-dev#184

GNU AGPL-3.0 License

Copyright (c) 2021 - present Core.ai

Original work Copyright (c) 2012 Adobe Systems Incorporated. All rights reserved.

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.