Very Popular
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+.
- Fork this repository to your own GitHub account.
- Clone the repository to your local device.
- Create a new branch
git checkout -b BRANCH_NAME
. - Change code then run the examples.
- Push your branch to Github after all tests passed.
- Make a pull request.
- Merge to master branch by our maintainers.
react-app
# run the example app in development mode
deno task dev examples/react-app
# run the example app in production mode
deno task start examples/react-app
# build the example app into a worker for serverless platform
deno task build examples/react-app
vue-app
# run the example app in development mode
deno task dev examples/vue-app
# run the example app in production mode
deno task start examples/vue-app
# build the example app into a worker for serverless platform
deno task build examples/vue-app
Testing
You can run all tests with the following command:
deno task test
Project Structure
- /commands commands of Aleph.js CLI
- /examples examples to get started
- /framework
- core framework core
- react framework in React
- vue framework in Vue.js
- /lib shared lib
- /loaders builtin loaders
- /server server of Aleph.js
Code Style We Followed
- Double quote for string
- Semicolons is good
- 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.