armgitaar / cleaver-setup-alpas Goto Github PK

This repo is the starter template for the Alpas web framework. 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.

It is fun to build an HTML web app or an API only app with Alpas.

Alpas strives to be simple and elegant and wants to serve you whether you have written any JVM based web apps before or not—there is no xml or properties files to configure, no scattered annotations to memorize—and yet, there is no huge learning curve to get started.

Alpas comes bundled with most of what you need to write modern web apps—authentication, auth scaffolding, email verification, notifications, mail, queues, fast and intuitive routing, powerful templating engine etc.—and yet it remains flexible for you to extend it to make it more powerful and delightful than it already is.

We have sweated picking the good parts, so you don’t have to!

Alpas is also very modular so you still have the authority to choose what you like and don't like. Create an HTML web app or keep it simple with an API only app, Alpas gets out of the way to let you take the control.

This repo is meant to be used as a template for starting a new Alpas web app. After creating a new repo off of this template and cloning on your local machine, make sure to follow the setup instructions to get started. After you have completed your app, don't forget to share which the community by requesting to add it to Alpas Resources

Please visit Alpas installation documentation for a full list of system requirements and pre-requisites. Here is a quick list of what you need:

• *nix machine. Windows is supported but only under the WSL or using GitBash.
• JDK version >= 9.0
• Gradle >= 5.6
• IntelliJ IDEA Community Editor or Ultimate.
• NodeJS and Yarn (Optional)

After you have finished selecting option to Use this template, added a project name, and cloned to your local machine per Creating New Project instructions, you can now perform the following steps on your machine to get rollin'!

1. At the root of the project, there is a script named alpas. Make it executable: chmod +x ./alpas
2. Initialize your new project using the full package name: ./alpas init com.example.myapp
3. To serve your app, do: ./alpas serve