Logframe Lab
Logframe Lab is an open source web application created to help NGOs and community-based organisations match their project ideas with the most relevant metrics for tracking their success. This tool leads you step-by-step through a simple process that results in a formatted, logical framework (logframe) that you can download and use for reporting your progress to your funders.
Its live at https://logframelab.ai
Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
Installing Dependencies
- Install Maven https://maven.apache.org/install.html
- Install Docker https://docs.docker.com/get-docker/
- Install docker-compose https://docs.docker.com/compose/install/
Quick Start
- Fork the repository
- Git clone the repository (Replace
YOUR-USERNAME)$ git clone https://github.com/YOUR-USERNAME/LogframeLab-server - Start the database and database manager containers
$ docker-compose up --build -d db phpmyadmin - Run the application with the dev profile (It becomes available at localhost:8080)
$ mvn spring-boot:run
The database manager is available at http://localhost:8082/. We use Swagger for API documentation which is available at http://localhost:8080/swagger-ui.html
Contributing
Want to help build on Logframe Lab? Check out our documentation here.
License
Logframe Lab is licensed under the terms of the Creative Commons Attribution Share Alike 4.0 license, which can be read in full here.
Maintainers
Osheena and Stephen are available at: sheena.amdadoo@gmail.com and yiriwayah@gmail.com
