TheLovinator/feedvault.se
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add empty Go project

Browse source
This commit is contained in:
Joakim Hellsén 2024-02-03 02:21:51 +01:00
commit 3445466197
30 changed files with 19 additions and 4183 deletions
Download patch file Download diff file Expand all files Collapse all files

51
README.md
View file

@ -2,9 +2,7 @@
_A seed vault for your feeds._
FeedVault is an open-source web application written in Python that allows users to easily archive RSS, Atom, and JSON feeds.
With FeedVault, users can effortlessly add their favorite feeds, ensuring they have a centralized location for accessing and preserving valuable content.
FeedVault is an open-source web application written in Golang that allows users to archive and search their favorite RSS, Atom, and JSON feeds. With FeedVault, users can effortlessly add their favorite feeds, ensuring they have a centralized location for accessing and preserving valuable content.
## Features
@ -18,53 +16,6 @@ _Note: Some features are currently in development._
- **User-Friendly Design**: FeedVault is designed to be simple, intuitive, and responsive, working seamlessly on both desktop and mobile devices.
- **Privacy-Focused**: FeedVault respects user privacy by not tracking or collecting any personal data. It is an ad-free platform that prioritizes user security.
## Getting Started
### Prerequisites
#### Development
Ensure you have the following installed on your machine if you plan to run FeedVault locally for development purposes:
- [Python 3.12](https://www.python.org/downloads/)
- [Poetry](https://python-poetry.org/docs/master/#installation)
- [PostgreSQL](https://www.postgresql.org/download/)
#### Production
Ensure you have the following installed on your machine if you plan to run FeedVault locally for production purposes:
- [Docker](https://docs.docker.com/get-docker/)
- [PostgreSQL](https://www.postgresql.org/download/)
### Installation
Clone the repository:
```bash
git clone https://github.com/TheLovinator1/FeedVault.git
```
Navigate to the project directory:
```bash
cd FeedVault
```
Install the project dependencies:
```bash
poetry install
```
Run the project:
```bash
poetry run site
```
Access FeedVault in your browser at http://localhost:8080.
## Usage
- Visit the FeedVault website.