civictechindex / CTI-website-frontend

Join a worldwide movement to catalog 
every open source 
civic tech project.
https://civictechindex.org
MIT License
30 stars 30 forks source link

Update README to be more complete #1219

Closed deserat closed 2 years ago

deserat commented 2 years ago

Overview

The README is pretty good but it's missing a few things that will help users new to Django and Docker get the project up and running.

Action Items

Assume no working knowledge of Django, Docker or Docker Comopose Walk through both setup methods described in the README add missing steps and links to resources which will allow users unfamiliar with these technologies to get set up quickly.

Resources/Instructions

(https://github.com/civictechindex/CTI-website-backend/blob/main/README.md)