arqaamio/logframelab-server

Backend Server for Logframe Labs.

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

1. Install Maven https://maven.apache.org/install.html
2. Install Docker https://docs.docker.com/get-docker/
3. Install docker-compose https://docs.docker.com/compose/install/

Quick Start

1. Fork the repository
2. Git clone the repository (Replace YOUR-USERNAME)

$ git clone https://github.com/YOUR-USERNAME/LogframeLab-server

3. Start the database and database manager containers

$ docker-compose up --build -d db phpmyadmin

4. 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: [email protected] and [email protected]

logframelab-server's Issues

Database optimization and refactoring

Improve the Database schema for LogframeLab

Improve authentication and autorization

Topics:

• how to secure the JWT strorage ( localstorage vs cookies security)
• token refresh time.
• securing indicator endpoints anonymous.
• JWT security best practices.

Please feel free to enhance the discussion with new topic and new ideas.

Improve sync between our database and the ML database

What I've talked with Ali Farid was that he wanted for us to call his update-knowledge-base endpoint every night that there an update or creation of indicators.
Open this discussion because Ali Kolai wanted to understand better our options.