diff --git a/doc/dependencies.md b/doc/dependencies.md new file mode 100644 index 000000000..0ab51422c --- /dev/null +++ b/doc/dependencies.md @@ -0,0 +1,63 @@ +Owncast Dependencies + +# Owncast Core + +## Frontend + +- video.js https://github.com/videojs/video.js +- Emoji-button https://github.com/joeattardi/emoji-button +- Preact https://github.com/preactjs/preact +- Htm https://github.com/developit/htm +- Mark.js https://github.com/julmot/mark.js +- Micromodal https://github.com/ghosh/micromodal +- Tailwind CSS https://tailwindcss.com/ + +## Backend + +- AWS SDK for Go https://aws.amazon.com/sdk-for-go/ +- Gorilla Websocket https://github.com/gorilla/websocket +- m3u8 HLS parser and writer https://github.com/grafov/m3u8 +- Log rotation https://github.com/lestrrat-go/file-rotatelogs +- Pkger file embeds https://github.com/markbates/pkger +- sqlite database driver https://github.com/mattn/go-sqlite3 +- Bluemonday HTML sanitizer https://github.com/microcosm-cc/bluemonday +- User agent parser https://github.com/mssola/user_agent +- joy5 RTMP protocol https://github.com/nareix/joy5 +- Unofficial MaxMind GeoIP2 Reader for Go https://github.com/oschwald/geoip2-golang +- For dumping SQL text https://github.com/schollz/sqlite3dump +- Logging library https://github.com/sirupsen/logrus +- ID string generator https://github.com/teris-io/shortid +- Markdown parser https://github.com/yuin/goldmark + +# Owncast Admin + +- React component library https://reactjs.org/ +- Ant design https://ant.design +- Chart.js chart library https://github.com/chartjs +- react-chartkick component https://chartkick.com/react +- date-fns time/date library https://date-fns.org/ +- markdown-it Javascript markdown parser https://github.com/markdown-it/markdown-it +- nextjs web framework https://nextjs.org/ +- ua-parser-js user-agent parser https://github.com/faisalman/ua-parser-js +- Markdown editor component https://github.com/HarryChen0506/react-markdown-editor-lite +- sass styling https://sass-lang.com/ + +# Owncast Directory + +## Frontend + +- Ant design https://ant.design +- date-fns time/date library https://date-fns.org/ +- nextjs web framework https://nextjs.org/ +- React component library https://reactjs.org/ +- sass styling https://sass-lang.com/ + +## Backend + +- HTTP routing https://github.com/gorilla/mux +- Mastodon API https://github.com/mattn/go-mastodon +- Twitter API https://github.com/ChimeraCoder/anaconda +- Go ORM https://gorm.io/gorm +- ID string generator https://github.com/teris-io/shortid +- Slug generator https://github.com/metal3d/go-slugify +- Logging library https://github.com/sirupsen/logrus