CONTRIBUTING.md

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 our examples.

# ssr
deno run -A --unstable --import-map=import_map.json cli.ts dev ./examples/hello-world -L debug
# ssg
deno run -A --unstable --import-map=import_map.json cli.ts build ./examples/hello-world -L debug

Testing

Run all tests:

deno test -A

Project Structure

• /cli command code
• /compiler compiler in rust with swc
• /framework framework code
• /design design drawings and assets
• /examples examples
• /plugins official plugins
• /server server code
• /shared shared code
• /test testings
• /vendor packages from npm

Code of Conduct

All contributors are expected to follow our Code of Conduct.