RSS Feed Django Project

Welcome to the RSS Feed Django project!

Table of Contents

• About the Project

• Build With

• Setup

  • Prerequisites
  • Installation

• Running the Project

• License

• Contributing

About the Project

This project is a web application built with Django Rest framework for content aggregation from RSS Feeds. This README file will guide you through the setup process, provide instructions for running the project, and explain how to contribute to its development.

Build With

• 
• 

Setup

Prerequisites

Before setting up the RSS Feed Django project, ensure that you have the following prerequisites installed on your machine:

• 
• 
• 

Installation

Follow these steps to set up the project:

Clone the repository using Git:

git https://github.com/rezatn0934/RSS-Feed-Aggregator.git

Create a virtual environment (optional but recommended):

python3 -m venv env

Activate the virtual environment:

For Windows:

env\Scripts\activate

For macOS/Linux:

source env/bin/activate

Install the project dependencies:

pip install -r requirements.txt

This command will install all the required Python packages listed in the requirements.txt file.

Set up the database:

python manage.py migrate

This will apply the database migrations and create the necessary tables.

Create a superuser account (admin):

python manage.py createsuperuser

Follow the prompts to set a phone number and password for the admin account.

Congratulations! The RSS Feed Django project has been successfully set up on your machine.

Running the Project

To run the RSS Feed Django project, follow these steps:

Activate the virtual environment (if not already activated):

For Windows:

env\Scripts\activate

For macOS/Linux:

source env/bin/activate

Start the server:

python manage.py runserver

License

Contributing

We welcome contributions to the RSS Feed Django project. If you'd like to contribute, please follow these steps:

Fork the repository on GitHub.

Clone your forked repository to your local machine:

git clone https://github.com/rezatn0934/RSS-Feed-Aggregator.git

Create a new branch for your changes:

git checkout -b feature/your-feature-name

Make the necessary changes and commit them:

git commit -m "Add your commit message here"

Push your changes to your forked repository:

git push origin feature/your-feature-name

Open a pull request on the original repository, describing your changes and explaining why they should be merged.

Wait for the project maintainers to review your pull request. Once approved, your changes will be merged into the main project.

Thank you for your interest in contributing to the RSS Feed Django project! We appreciate your help.