Skip to main content
Module

x/aleph/CONTRIBUTING.md

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

Contributing to Aleph.js

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

  • Submit new features
  • Report and fix bugs
  • Review code
  • Improve our documentation

Development Setup

You will need Deno 1.20+.

  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. Merge to master branch by our maintainers.

Run The Examples

# Run the example app in development mode
deno run -A dev.ts examples/$APP/server.ts

# Run the example app in production mode
deno run -A examples/$APP/server.ts

# Optimize the application (bundling, ssg, etc.)
deno run -A examples/$APP/server.ts --build

Examples: https://github.com/alephjs/aleph.js/tree/main/examples

Testing

You can run all the testings by the following command:

deno test -A

Project Structure

  • /examples examples to get started
  • /framework
    • core framework framework core
    • react framework framework for React
  • /server server core of Aleph.js
  • /shared shared libraries
  • /tests unit/integration testings

Code Style We Followed

  • Double quote for string
  • Ends with semicolon
  • 2 spaces indent
  • Types everything
  • Order the imports
  • Remove unused code
  • Format code before commit
deno fmt **/*.{ts,tsx}

Code of Conduct

All contributors are expected to follow our Code of Conduct.