If you are reading this then maybe I’ve convinced you to try out both Kotlin and Alpas by writing a complete web app. I’m super happy you are here and I’ll try my best to make sure your time is worth it and well spent. Let’s get started!
We will keep this post short and simple. We are just going to create a new project from a template, talk about few things that you need to know right off the bat, and build and run it.
Get started by first making sure your system is ready for writing a Kotlin web app using Alpas.
Now, visit Alpas starter template repo and create a new repo based on this template (click that green Use this template button).
- Name your repo fireplace and clone it on your local machine.
- At the root of the project there is a script named alpas. Make it executable:
chmod +x ./alpas
- Initialize your new project using the full package name:
./alpas init com.example.fireplace
- Once done, to serve your app, do:
- Just to make sure that your frontend dependencies are not outdated, run
yarn install && yarn dev(make sure that you have NodeJS and npm installed).
- Download the excellent IntelliJ IDEA and open the project.
There isn’t much to do for this part. But once you open the project, browse the app to try to get an idea of the structure of an Alpas web app. This will help you to navigate faster when we start adding more features in future.
To help you get oriented, here are are some of the files you can skim over:
The is the file where it all starts. You probably never have to touch this file except for actually running the app. IntelliJ should have a “green play button” right next to the
main function that you can click to run your app.
This contains all your environment related configuration values. You can override so many of the core configuration values in this file.
Start by changing the value of APP_NAME variable and see what happens when you run your app again. Can you change the port address at which your app is served by changing one of the values here? Which one?
Do a quick read on Configuration documentation to better understand one of the most critical components of Alpas.
This class file is where you’d be adding database connections for running CRUD operations. I highly recommend going over Database Getting Started documentation to prepare for the next part.
All your app routes should be kept in this file. You can read more about Alpas Routing to be better prepared as we’ll be adding bunch of them here very soon.
The controller responsible for deciding which page gets rendered when the home page route is matched. Alpas Controllers documentation is a quick read.
The “landing” page of the app. Feel free to tweak it if you want to but don’t remove anything yet. You can change the title of the page if you want. Being familiar with Alpas Templating engine is going to help you move much faster.
We did not write anything in this post but only created a project and that was intentional. I want you to spend some time reading Alpas docs.
Don’t worry, you don’t need to know everything; just being familiar with where to look for things is more than enough at this time.
If you found a bug please open an issue. If you have questions, comments, or feedback, or if you just want to hangout with people who are learning Alpas and with people who built Alpas, we have a dedicated Slack for that. We’d love to have you there. Please join us !
See you in the next one!
Questions? Ask us in our Slack.