sharpetronics/DrogonCMS
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Add development documentation and update Cambalache version #29

Merged
sharpetronics merged 1 commits from drogonCMS-cmake into master 2024-11-11 19:25:38 -05:00
Conversation 0 Commits 1 Files Changed 3 +92 -3
3 changed files with 92 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files
Showing only changes of commit 8273ba0217 - Show all commits

2
CMakeLists.txt
View File

@ -155,7 +155,7 @@ include_directories(${GTK4_INCLUDE_DIRS} ${ADW_INCLUDE_DIRS})
link_directories(${GTK4_LIBRARY_DIRS} ${ADW_LIBRARY_DIRS})
add_definitions(${GTK4_CFLAGS_OTHER} ${ADW_CFLAGS_OTHER})
# Include vendor source code locally
# Include vendor source code locally/manually
add_subdirectory(vendors/api-server/)
add_subdirectory(vendors/simple-reverse-proxy/)

89
DEV_README.md Normal file
View File

@ -0,0 +1,89 @@
# DEVELOPER JOURNAL
# V1.0.0
# The Design Flow/Pattern of the GTK4/C Application
# Cambalche Update, Configure & Meson Install Instructions:
So, instructions that worked for me on Arch Linux if you want to manually build/install Cambalache v0.93.
0. `git clone https://gitlab.gnome.org/jpu/cambalache.git && cd cambalache`
1. `meson setup --wipe --prefix=~/.local _build .`
2. `ninja -C _build install`
3. Update `~/.bashrc paths`
```
# Add paths for Cambalache app
export PYTHONPATH=~/.local/lib/python3.12/site-packages/
export GI_TYPELIB_PATH=~/.local/lib/girepository-1.0/
export LD_LIBRARY_PATH=~/.local/lib/
```
4. *Optional* Add `~/.local/bin` to $PATH via `~/.bashrc` profile directly
```
# Then, export and append .local/bin PATH to PATHS for launching Cambalache application
export PATH=/home/username/.local/bin:$PATH
EXIT and SAVE the .bashrc file
```
4a. In the terminal/CLI, refresh .bashrc profile
`source ~/.bashrc`
4b. Launch Cambalache via terminal (CLI)
`cambalache`
Note 1: You also may need to copy libs over from local `./_build/cambalache/private` directory to `/home/username/.local/lib`.
### The specific files I copied
* CambalachePrivate-3.0.gir
* CambalachePrivate-3.0.typelib
* CambalachePrivate-4.0.gir
* CambalachePrivate-4.0.typelib
* libcambalacheprivate-3.so.p (DIR)
* libcambalacheprivate-4.so.p (DIR)
# Steps to Build *DrogonCMS* from Source Code
0. Clone the repository `git clone https://git.sharpetronics.com/sharpetronics/DrogonCMS` and `cd DrogonCMS/`
1. *optional* checkout correct branch e.g. `git checkout drogonCMS-cmake`
2. Run `cmake -D CMAKE_BUILD_TYPE=Release .`
3. Then, to build the executable, we do `cmake --build .`
4. Run the app with `./DrogonCMS`
## Developer Requirements
*Drogon* framework compile/build dependencies.
* Drogon >= 1.9.1 https://github.com/drogonframework/drogon/wiki/ENG-02-Installation#System-Preparation-Examples
## Developer Recommendations
A GTK4 editor is a recommended tool for this project; all UI's and project files **.cmb** are stored in `./src/ui/`.
* Cambalache >= 0.93 https://gitlab.gnome.org/jpu/cambalache
An optional recommendation is Geany IDE.
* Geany IDE https://www.geany.org/
## IDE build commands via Geany `Build -> Set Build Commands`
### This is what my build commands look like in *Geany IDE* with **GNU Automake Tools**.
| Name | Command | Working Directory |
| ----------- | ------------------ | -------------------------------------------------------------------- |
| Configure | ../configure | /home/username/Desktop/Local-Development/cplusplus/drogon-dash/build |
| AutoReconf | autoreconf -vi | /home/username/Desktop/Local-Development/cplusplus/drogon-dash |
| Make | make | /home/username/Desktop/Local-Development/cplusplus/drogon-dash/build |
| Run | ./drogon_dashboard | /home/username/Desktop/Local-Development/cplusplus/drogon-dash/build |
| Make Bins | make dist | /home/username/Desktop/Local-Development/cplusplus/drogon-dash/build |
### This is what my build commands look like in Geany IDE with **BSD CMake Tools**.
| Name | Command | Working Directory |
| ----------- | ------------------ | -------------------------------------------------------------------- |
| Configure | cmake -D CMAKE_BUILD_TYPE=Release | /home/username/Desktop/Local-Development/cplusplus/DrogonCMS/ |
| Build | cmake --build . | /home/username/Desktop/Local-Development/cplusplus/DrogonCMS |
| Run GUI | ./DrogonCMS | /home/username/Desktop/Local-Development/cplusplus/DrogonCMS/ |
| Run API | ./DrogonCMS-API-Server | /home/username/Desktop/Local-Development/cplusplus/DrogonCMS/vendors/api-server/ |
| Install | cmake --install | /home/username/Desktop/Local-Development/cplusplus/DrogonCMS/ |

4
README.md
View File

@ -77,7 +77,7 @@ Transfer/sec: 21.24MB
* Gtk4 >= 4.0
* Adwaita >= 1.3.5
* OpenSSL >= 3.1.2
* *Optional* Cambalache >= 0.14 (Gtk4 Editor) [SEE 3RD PARTY SITE DEPENDENCIES]
* *Optional* Cambalache >= 0.93 (Gtk4 Editor) [SEE 3RD PARTY SITE DEPENDENCIES]
* *Optional* Geany IDE >= 1.38
* CLI Experience
* Git/Github Experience
@ -100,7 +100,7 @@ Transfer/sec: 21.24MB
### Recommendations
A GTK4 editor is a recommended tool for this project; all UI's and project files **.cmb** are stored in `./src/ui/`.
* Cambalache >= 0.14 https://gitlab.gnome.org/jpu/cambalache
* Cambalache >= 0.93 https://gitlab.gnome.org/jpu/cambalache
An optional recommendation is Geany IDE.
* Geany IDE https://www.geany.org/