search

COVIDImpact / CovidImpact

COVID-19 is impacting countless small businesses across Canada, we all face uncertainty. Several colleagues and I asked what we could do to help? After a weekend of non-stop coding we’ve put together #CovidImpact, a FREE Small Business Care Package which features: A curated list of programs to help them through the crisis. Real-time news relevant to Canadian ventures Simulation tool to see how their business may be affected across various scenarios depending on how long COVID-19 drags out for. Together, Canadian businesses will get through this by supporting each other! CovidImpact is built in Vue with Javascript, HTML and CSS files. The project utilizes various Bootstrap-Vue components and newsapi.org to get the latest business news. The app is hosted on S3 and uses serverless functions for a mailchimp newsletter.
http://covidimpact.ca/
Apache License 2.0
3 stars 0 forks source link

Improve README.md #38

Open NoirKomBatman opened 4 years ago

NoirKomBatman commented 4 years ago

Overview:

We need a more clear README.md that tells about the high-level architecture of CovidImpact

What needs to be done:

  1. Update README.md
  2. Include the architecture diagram of how serverless, S3, CDN, Route53 and Vue app work together. Use drawio or your preferred drawing service
  3. Add links to app/README.md and serverless/README.md and point that the installation instructions for each respectively is there

Criteria of success:

  1. README.md files are updated
  2. Root README.md has the architecture diagram

Documentation:

https://app.diagrams.net/

Stakeholder:

@NoirKomBatman