🌟 RSS Final Project 🌟

Hello this is my final project for the makatab course. it host's a rss feed parser web application witch is written in django and django rest frame-work. the project is based upon diffrent technologies and It uses multilingual aspects as well.

Reminder: this is a full back-end project so dont look forward to a pretty front.

Programmer

Alireza(Arad) Arvin GitHub Account

Table of Contents

• Technologies Used
• Starting Notes
• Installation Guide
• Docker Compose

Technologies Used

The technologies used by this app are mentioned below:

Programming language:

• 

Frameworks:

• 
• 

Third party appps:

• 
• 
• 
• 
• 
• 
• 
• 

Starting Notes

This app is using the docker technology, so the app settings are configured to run on docker. please follow the installation guide carefully.

Installation Guide

Since this project uses the django project technology I recommend you to read this part to properly set up the project.

• 1. first: It's better to fork this project to your own repo.(of course you can skip this step...)

• 

• 2. clone the forked repo to you'r local repository >>>

git clone https://github.com/AradArvin/RSSFinalProject.git

• 3. make a virtual environment for the django project(you should use a venv. It's recommended) >>>

python3 -m venv .venv

• 4. activate the venv >>>

source .venv/bin/activate

• 5. now you need to dockerize the project >>>

docker compose -f "docker-compose.yml" up -d --build

This command first creates the docker containers and then upstreams the app so that it could run.

Now you are ready to inspect the project and enjoy It's aspects. All you need to do now is to enter http://127.0.0.1:8000/ in your browser and navigate the urls in the app.

• In order to stop the docker and exit the project:

docker compose -f "docker-compose.yml" down

make sure that docker is installed on you'r computer

Docker Compose

There are a few things you must consider when dockerizing:

1. the docker containers are built using the docker-compose.yml file. in fact this file is responsible for the whole dockerizing process. so make sure that you are in the directory of this file then docker build up.

2. since docker use a great amount of you'r hardware, make sure you'r pc is capable of running a big number of containers.

3. the database is using a virtual environment variable or .env file so you need to enter your own config in order to run this app.

the configs you need to involve in the .env file are:

• DATABASE_NAME
• DATABASE_USER
• DATABASE_PASSWORD
• DATABASE_HOST
• DATABASE_PORT

keep in mind that the database used in this project is postgresql.