armgitaar / alpasdev Goto Github PK

This repo is the marketing and documentation code of the Alpas web framework. If you want to create a new Alpas app, please visit the Alpas starter template repository. If you want to contribute to the core of Alpas framework, please visit the core Alpas repository.

Alpas is a batteries-included, yet a modular web framework for Kotlin with a very strong focus on developers' productivity. The main goal of Alpas is to get you started quickly and enable you to move faster while letting you enjoy doing what you are the best at — crafting a delightful web app.

To contribute to the documentation of Alpas, please follow the following steps:

1. Make sure you have all the system requirements needed by Alpas.
2. Fork this repo and clone it on your machine.
3. Make a copy of .env.example and name it .env.
4. The root of the project contains an alpas script. Make it executable: chmod +x ./alpas
5. Build and serve the project: ./alpas build && ./alpas serve
6. Make the changes, build, and run it locally.
7. Send a PR.

Thank you for making Alpas better!