16 lines
1.9 KiB
Markdown
16 lines
1.9 KiB
Markdown
The repository contains a few folders that make up **RSS-Bridge**. Here is a brief description of what you can expect to find where:
|
|
|
|
Folder | Description
|
|
-------|------------
|
|
[`actions/`](https://github.com/RSS-Bridge/rss-bridge/tree/master/actions) | Contains all “[controllers](https://en.wikipedia.org/wiki/Model%E2%80%93view%E2%80%93controller)” for the web front-end.
|
|
[`bridges/`](https://github.com/RSS-Bridge/rss-bridge/tree/master/bridges) | Contains all bridges that are currently supported. Each file represents one Bridge that is displayed on the [Welcome screen](../01_General/04_Screenshots.md#welcome-screen) of **RSS-Bridge**
|
|
[`caches/`](https://github.com/RSS-Bridge/rss-bridge/tree/master/caches) | Contains implementation for different cache back-ends supported.
|
|
[`contrib/`](https://github.com/RSS-Bridge/rss-bridge/tree/master/contrib) | Contains various helpers for development and release process.
|
|
[`docs/`](https://github.com/RSS-Bridge/rss-bridge/tree/master/docs) | Contains this documentation.
|
|
[`formats/`](https://github.com/RSS-Bridge/rss-bridge/tree/master/formats) | Contains all export formats.
|
|
[`lib/`](https://github.com/RSS-Bridge/rss-bridge/tree/master/lib) | Contains the core API and helper functions.
|
|
[`static/`](https://github.com/RSS-Bridge/rss-bridge/tree/master/static) | Contains all static assets for the web front-end, including images, style sheets and JavaScript code.
|
|
[`templates/`](https://github.com/RSS-Bridge/rss-bridge/tree/master/templates) | Contains templates for producing the HTML of the web front-end.
|
|
[`tests/`](https://github.com/RSS-Bridge/rss-bridge/tree/master/tests) | Contains the test suite and fixtures.
|
|
[`vendor/`](https://github.com/RSS-Bridge/rss-bridge/tree/master/vendor) | Contains third-party libraries used by **RSS-Bridge**. Development of all files in this folder must be done in the vendor specific repository (not part of **RSS-Bridge**)
|