Repo documentation - Githubissues

CivicTechTO / toronto-bids

4 stars 2 forks source link

Repo documentation #43

Open AcharyaS97 opened 1 year ago

AcharyaS97 commented 1 year ago

[ ] Contribution Guide
[ ] Setup guide for scraper
[ ] Setup guide for Clojure Web App
[x] Setup guide for Angular Web App
[ ] Setup guide for PHP Web App
[ ] Setup guide for Upload function
[x] DB Documentation

gabesawhney commented 1 year ago

Also:

Overall/orientation readme. Including project "status"?

gabesawhney commented 1 year ago

As discussed on May 31st call, Saheel will:

[x] write simple documentation explaining the two DB schemas
[ ] write basic build documentation for the uploader
[x] write basic build documentation for the Angular webapp

Gabe will:

[ ] write basic build documentation for the php frontend
[ ] create a skeleton readme for the build doc for the scraper
[ ] try setting up the scraper

Ajay:

[ ] also interested in trying to set up the scraper. (but no promises!)
[ ] once skeleton or draft build docs are up, will contribute