You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+28-6Lines changed: 28 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,6 +4,14 @@ This is a Django app that creates filtered RSS feeds. It does this by filtering
4
4
5
5
It comes with one view that returns the filtered feed XML, as well as Django Admin configuration to make it possible and easy to self-host your own instance of django-rss-filter. It does not come with views to create or edit filtered feeds; this can be done using the Django Admin.
6
6
7
+
## What is this?
8
+
9
+
This is a plugin (an "app") for the Django web framework. It is **not a standalone application** ready to deploy, and requires a Django project to run.
10
+
11
+
**If you are a Django developer:** You're in the right place! Skip to the "Getting started" section to integrate this app into your project.
12
+
13
+
**If you just want a simple, ready-to-run RSS filtering server:** Simply use https://www.rssfilter.com which has user-friendly ways to create and edit filtered RSS feeds.
14
+
7
15
## Getting started
8
16
9
17
All instructions use [uv](https://docs.astral.sh/uv/), but should work just as well with pip or Poetry for example.
@@ -29,16 +37,30 @@ This will get you up and running with a working Admin site at http://127.0.0.1:8
29
37
30
38
Then follow the first four steps to add django-rss-filter to your Django project.
31
39
32
-
## Example project
40
+
## How to run the example project
33
41
34
42
There's an example Django project using django-rss-filter under `example/`.
35
43
36
-
1.`cd example`
37
-
2.`uv run ./manage.py migrate`
38
-
3.`uv run ./manage.py createsuperuser`
39
-
4.`uv run ./manage.py runserver`
44
+
All instructions use [uv](https://docs.astral.sh/uv/), but should work just as well with pip or Poetry for example.
45
+
46
+
1.**Clone this repository and navigate into the example project folder:**
2. **Set up the database and create an admin user:**
53
+
```sh
54
+
uv run ./manage.py migrate
55
+
uv run ./manage.py createsuperuser
56
+
```
57
+
58
+
3. **Run the server:**
59
+
```sh
60
+
uv run ./manage.py runserver
61
+
```
40
62
41
-
Youcan then go to http://127.0.0.1:8000/admin/ to create a feed, which you can then access at http://127.0.0.1:8000/[feed_uuid]/.
63
+
4. **You're done!** You can now go to http://127.0.0.1:8000/admin/ to create a feed using the superuser account you just created. You can then access the filtered feed at `http://127.0.0.1:8000/[feed_uuid]/`.
0 commit comments