Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/colinkiama/elementary-app-template
Modern App Template for elementary OS (Batteries Included!)
https://github.com/colinkiama/elementary-app-template
app app-template application elementary elementary-os elementaryos flatpak github-template github-templates meson mesonbuild project-template python repo-template template template-project vala
Last synced: about 1 month ago
JSON representation
Modern App Template for elementary OS (Batteries Included!)
- Host: GitHub
- URL: https://github.com/colinkiama/elementary-app-template
- Owner: colinkiama
- Created: 2024-08-28T17:29:02.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-09-14T18:48:50.000Z (3 months ago)
- Last Synced: 2024-10-11T18:51:23.016Z (2 months ago)
- Topics: app, app-template, application, elementary, elementary-os, elementaryos, flatpak, github-template, github-templates, meson, mesonbuild, project-template, python, repo-template, template, template-project, vala
- Language: Meson
- Homepage:
- Size: 203 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# {{APP_TITLE}}
{{APP_SUMMARY}}
This project was generated from elementary-app-template
## How to Generate Projects From This Template
### Latest version
Template releases align with elementary Flatpak platform releases.
`main` branch follows the latest elementary Flatpak platform version as closely as possible.
So you can press the "Use this template" button to use the latest template.
### Older versions
For templates based on older elementary Flatpak platorm versions, you can either:
- Download archives from GitHub releases
- Check out tag branches corresponding the elementary Flatpak platform version you would like to target
e.g `7.3.0` for the template targeting elementary Flatpak Platform 7.3. You can then manage the git history and refs to meet your needs.
## Build Instructions
### Flatpak (Recommended)
Either:
- Use Visual Studio Code with [Flatpak extension](https://marketplace.visualstudio.com/items?itemName=bilelmoussaoui.flatpak-vscode)
- Use [GNOME Builder](https://apps.gnome.org/en-GB/app/org.gnome.Builder/)
- Flatpak integrations of your preferred IDE/Code Editor
- Or use the [flatpak and flatpak-builder](https://docs.flatpak.org/en/latest/first-build.htm) commands.
### Meson
#### Dependencies
- glib-2.0
- gobject-2.0
- gee-0.8
- gtk4
- granite-7
- libadwaita-1
#### Template Setup
Before you can build the project, you'll need to setup your project from the template.
Make the `setup` script exectuable if it isn't already:
(Assuming you're in the project root)
```sh
chmod +x ./setup
```
Then run the `./setup` script
(Assuming you're in the project root)
```sh
./setup
```
After running the setup script, you will be ready to build the project.
#### Build Commands
To setup build diectory:
```sh
meson build --prefix=/usr
```
To build:
(Assuming you're in the project root and have already setup the build directory)
```sh
cd build
ninja
```
To test:
(Assuming you're in the project root and have already built the app)
```sh
cd build
meson test
```
Or, to get more details about what's happening in the tests, add the `--verbose` flag:
```sh
cd build
meson test --verbose
```
To install:
(Assuming you're in project root)
```sh
cd build
sudo ninja install
```
## Publishing app to AppCenter
For information about publishing elementary OS apps to the AppCenter, visit the elementary OS developer documentation: https://docs.elementary.io/develop/appcenter/publishing-requirements