Skip to main content
Module

x/aleph/CONTRIBUTING.md

The Full-stack Framework in Deno.
alephjs/aleph.js
Very Popular
Go to Latest
File

Contributing to Aleph.js

Welcome, and thank you for taking time in contributing to Aleph.js! You can improve Aleph.js in different ways:

  • ∆ add new features
  • ✘ bugfix
  • ✔︎ review code
  • ☇ write plugins
  • 𝔸 improve our documentation

Development Setup

You will need Deno 1.7+.

  1. Fork this repository to your own GitHub account.
  2. Clone the repository to your local device.
  3. Create a new branch git checkout -b BRANCH_NAME.
  4. Change code then run the examples.
  5. Push your branch to Github after all tests passed.
  6. Make a pull request.
  7. Marge to master branch by our maintainers.
# ssr/development with HMR
ALEPH_DEV_PORT=2020 deno run -A --unstable --location=http://localhost cli.ts dev ./examples/hello-world -L debug

# ssr/production
ALEPH_DEV_PORT=2020 deno run -A --unstable --location=http://localhost cli.ts start ./examples/hello-world -L debug

# ssg
ALEPH_DEV_PORT=2020 deno run -A --unstable --location=http://localhost cli.ts build ./examples/hello-world -L debug

# run all tests
deno test -A --unstable --import-map=import_map.json --location=https://deno.land/x/aleph

Project Structure

  • /cli commands code
  • /compiler compiler in rust powered by swc
  • /framework
    • core framework core code
    • react framework in React
  • /design design drawings and assets
  • /examples examples
  • /plugins plugins
  • /server server code
  • /shared shared code

Code of Conduct

All contributors are expected to follow our Code of Conduct.