📄 Management Blog

Table of Contents

• About the Project
• How to install?
• Built With

About the Project

Management Blog is a system that allows users to register, edit and delete articles, as well as rate published content.

It has the following features:

• User registration
• Authentication system
• Category registration
• Registering/Updating/Deleting articles
• List of articles
• Search for articles by any data provided

How to install?

Running the project on your machine is a simple process. Make sure you have Docker Engine or Docker Desktop installed on your machine. Then update the environment variables in the .env file, as follows:

SQLALCHEMY_DATABASE_URI=
SQLALCHEMY_TRACK_MODIFICATIONS=
SQLALCHEMY_ECHO=

JWT_SECRET_KEY=

ELASTICSEARCH_URL=
ELASTICSEARCH_USER=
ELASTICSEARCH_PASSWORD=

After that, start all the services declared in the docker-compose file. To do this, run the following command.

$ docker-compose up -d --build

With the containers running, we need to migrate their models to our postgres database. To do this, run the following commands:

$ docker exec -it blog-api /bin/bash

root@274c42373ef1:/app# flask db migrate

root@274c42373ef1:/app# flask db upgrade

Now our application is running. If you want to test it, run the following commands:

$ docker exec -it blog-api /bin/bash

root@274c42373ef1:/app# export TESTING=True

root@274c42373ef1:/app# pytest

Built With

• Backend Framework: Flask
• Database technology: Postgres, Elasticsearch, and SQLite
• Backend data processing technology: SQLALchemy
• Technology for testing implementation: Pytest
• API documentation tool: SwaggerHUB
• Diagram creation tool: dbdiagram.io