Skip to content

sobabear/RSSEndPoint

Repository files navigation

RSS Feed API

A NestJS backend service that provides RSS feed information from various countries and categories.

Features

  • Get RSS feeds by country
  • Get all RSS feeds (except country-specific ones)
  • Get RSS feeds by category
  • PostgreSQL database for data persistence
  • Docker and Docker Compose setup
  • Nginx reverse proxy

Prerequisites

  • Docker and Docker Compose
  • Node.js 18+ (for local development)

Setup

  1. Clone the repository
  2. Create a .env file based on the environment variables in docker-compose.yml
  3. Run the services:
docker-compose up -d

API Endpoints

  1. Get RSS feeds by country:

    GET /rss/country?code=US
    
  2. Get all RSS feeds (except country-specific):

    GET /rss
    
  3. Get RSS feeds by category:

    GET /rss/category?name=Technology
    

Development

  1. Set Env
echo 'DB_PASSWORD={your db password}!' > .env && cat .env
  1. Install dependencies:

    npm install
  2. Run in development mode:

    npm run start:dev

Database Schema

  • Country (id, name, code)
    • One-to-many relationship with CountryRss
  • CountryRss (id, title, feedUrl, domain)
    • Many-to-one relationship with Country
  • Category (id, name)
    • One-to-many relationship with CategoryRss
  • CategoryRss (id, title, feedUrl, domain)
    • Many-to-one relationship with Category

License

MIT

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published