Contribution

Blok is an open-source project built to redefine how developers architect and deploy scalable applications. Whether you're passionate about optimizing workflows, building reusable nodes, or improving developer experience, your contributions can make a real impact! Help us shape the future of modular cloud development by submitting nodes, addining more functionality, improving documentation, or sharing feedback. Every contribution—big or small—pushes the project forward. Jump in, collaborate, and let’s build something amazing together! 💡🔧

How to Contribute

Step:

Fork & Clone the repository.

Step:

Make changes based on the project roadmap or propose the changes there.

Step:

Create tests and make sure you have 100% coverage.

Step:

Submit a Pull Request with a clear description following the provided template.

Setting up the Development Environment

To set up the development environment, follow the steps below:

Step:

git clone https://github.com/deskree-inc/nanoservice-ts.git
cd nanoservice-ts

Step:

The following command will install the dependencies required for the project.

pnpm install

Step:

The following command will create the .env.local required by the tests in the runner project.

make prepare

Before committing your changes

Step:

The following command will will create the build for all the projects because as required by monorepo.

pnpm build

Step:

If you've made any changes to the /core of the project, make sure you you run the following command to update the TypeDoc documentation. The following command will install the dependencies required for the project.

npm run doc:generate

Step:

The following command will execute the test in all the projects

pnpm test

Best Practices

Step:

Follow TypeScript standards for consistency.

Step:

Keep in mind the objectives of the project

Step:

Document your code and make adjustments to the /docs section if your changes affect the public use of the framework.