search

hikaya-io / activity

Making it easier for nonprofits to manage their project activities and indicators. Interested in contributing? Check out our open issues: https://tinyurl.com/activity-issues
https://hikaya.io/products/activity/
Apache License 2.0
80 stars 5 forks source link

Update documentation #760

Closed TAnas0 closed 3 years ago

TAnas0 commented 3 years ago

What is the Purpose?

Update our basic documentation in the repository. The README is a bit overwhelming and too specific. It also tries to describe all possible scenarios for running Activity:

I'd rather have a friendlier README with a quick Getting Started section based on Docker and Docker Compose, and leave the rest to the user who is doing the setup, and knows their machine.

What was the approach?

Briefly describe the approach used to address the issue

Are there any concerns to addressed further before or after merging this PR?

None

Mentions?

@andrew @ninetteadhikari

Issue(s) affected?

Fix #758

codecov[bot] commented 3 years ago

Codecov Report

Merging #760 (5085932) into develop (baa15a0) will not change coverage. The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff            @@
##           develop     #760   +/-   ##
========================================
  Coverage    57.61%   57.61%           
========================================
  Files          143      143           
  Lines         9223     9223           
========================================
  Hits          5314     5314           
  Misses        3909     3909