design
fl-tech
&
design
fl-tech
&
Small manual
Basis for new apps: A flexible template
This template provides a solid starting point for developing new apps. It is ideal for developers and newcomers who need a structured foundation or inspiration for their projects. The focus is on providing a clear and expandable architecture.
Note: The app in its current form is not directly installable, as it does not yet contain specific features – apart from a simple "Show Mode". It primarily serves as a reference and example for structuring a project.
Structure of the template
The template is divided into two main folders: app and data . This structure ensures clear organization of the files and makes the project more manageable.
​
1. The app Folder
The app folder contains all essential components of the application. It is further divided into three subfolders:
​
my_widgets:
- Contains various .kv files with pre-built widgets that can be used in the app.
- Here you can create your own widgets and define reusable elements that can be utilized in different parts of the app.
- Example: Buttons, input fields, or layouts that are needed multiple times.
​
services:
- Includes all files responsible for background processes.
- Typical examples are:
- app_config.py: Configuration file for global settings.
- data_manager.py: Management of databases or files.
- user_manager.py: User management and authentication.
- All functions that are not directly visible but run in the background are located here.
​
ui:
- Contains everything related to the User Interface (UI).
- This folder houses all visible elements of the app that can be interactively operated during runtime.
- Example: Screens, menus, dialog windows, or other graphical interfaces.
​
2. The data Folder
The data folder serves as a storage location for all files that contribute to the functionality of the app but are not directly part of the application itself. These include, for example:
- Configuration files
- Test data
- Assets such as images or icons
​
Why Use This Template?
- Clarity: The clear division into subfolders keeps the project structured, even as it grows in size.
- Flexibility: The template provides a solid foundation that can be adapted to individual requirements.
- Learning Aid: For developers new to app development, it serves as a practical example of a clean project structure.
Installation
No worries, I’ll guide you step by step through the installation. All you need is a little time and a bit of curiosity.
Let’s get started...
1. Download the Project
First, you need to load the project onto your computer. This is very easy to do with Git. To do this, open your Terminal (or Command Prompt on Windows) and execute the following commands:
git clone https://github.com/fl-tech-design/empty_kivy_template.git
cd empty_kivy_template
What’s happening here?
- The first command (git clone) downloads the project from GitHub.
- With cd empty_kivy_template, you switch to the folder where the project is stored.
2. Create a virtual environment (optional, but recommended)
To ensure that all dependencies are installed correctly and that there are no conflicts with other projects, I recommend using a virtual environment. This is like a small, isolated room for your project.
To do this, run the following commands:
python3 -m venv venv
source venv/bin/activate # On Windows: `venv\Scripts\activate`
What does this mean?
python3 -m venv venv creates a new virtual environment in the venv folder.
source venv/bin/activate activates the environment. On Windows, use venv\Scripts\activate instead.
3. Install dependencies
For the app to work, we need to install the required libraries. This is easily done with a single command:
pip install -r requirements.txt
What does this command do?
The requirements.txt file contains a list of all required Python libraries. This command will install them automatically.
4. Start the app
Now comes the exciting part: We launch the app! Simply enter the following command:
python3 main.py
What happens now?
This command launches the app. If everything was installed correctly, you should see the user interface.
Complete!
That's it. You've successfully installed and launched the app. If you get stuck somewhere or have questions, take a close look at the error messages – they often give you a hint as to what to do. And of course, you can always ask me. Have fun exploring and experimenting!