Benature/omnivore
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #73 from omnivore-app/docs/add-readme-shoutouts

Browse Source 
Add a section in the README on the OSS we use
This commit is contained in:
Jackson Harper
2022-02-17 04:45:13 +08:00
committed by GitHub
parent 3a27681534 01575e7780
commit 0e6a5a88e4
1 changed files with 16 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -30,13 +30,27 @@ We also have a free hosted version of Omnivore at [omnivore.app](https://omnivor
<img width="981" alt="omnivore-readme-screenshot" src="https://user-images.githubusercontent.com/75189/153696698-9e4f1bdd-5954-465b-8ab0-b4eacc60f779.png">
## Join us on Discord!
## Join us on Discord! :speech_balloon:
We're building our community on Discord. [Join us!](https://discord.gg/h2z5rppzz9)
Read more about Omnivore on our blog. <https://blog.omnivore.app/p/getting-started-with-omnivore>
## How to setup local development
## Shoutouts :tada:
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/).
* [SWR](https://swr.vercel.app/) - We do all our data fetching on the web using SWR.
* [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.
* [Swift GraphQL](https://www.swift-graphql.com/) - We generate our GraphQL queries on iOS using Swift GraphQL.
* [Radix](https://www.radix-ui.com/) - We use Raxix UI's components on our frontend.
* And many more awesome libraries, just checkout our package files to see what we are using.
## How to setup local development :computer:
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.