From 197e038f37c5edb09b1a196b61255b83aaaf4e41 Mon Sep 17 00:00:00 2001 From: Jackson Harper Date: Wed, 16 Feb 2022 10:43:38 -0800 Subject: [PATCH] Add a section in the README on the OSS we use --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 4d1358dea..32ae41363 100644 --- a/README.md +++ b/README.md @@ -36,6 +36,16 @@ We're building our community on Discord. [Join us!](https://discord.gg/h2z5rppzz Read more about Omnivore on our blog. +## Shoutouts + +Omnivore takes advantage of some great open source software: + +* [TypeScript](https://www.typescriptlang.org/) - Most of our backend and frontend are written in TypeScript. +* [Next.js](https://nextjs.org/) - Our frontend is a Next.JS app and is hosted on [Vercel](https://vercel.com/) +* [Stitches](https://stitches.dev/) - We use stitches on the frontend to style our components. +* [Mozilla Readability](https://github.com/mozilla/readability) - We use Mozilla's Readability library to make pages easier to read. + + ## How to setup local development The easiest way to get started with local development is to use `docker-compose up`. This will start a postgres container, our web frontend, an API server, and our content fetching microservice.