Code Monkey home page Code Monkey logo

blogscribe's Introduction

Blogscribe

Blogscribe is a clone of the popular blogging platform Medium. This repository contains the API for Blogscribe.

Features

  • User registration and authentication
  • Creating, editing, and deleting blog posts
  • Liking and commenting on blog posts
  • Following other users and receiving notifications
  • Categorizing blog posts using tags
  • Searching for blog posts by keywords or tags
  • Pagination and sorting of blog posts
  • User profiles with bio and profile picture
  • User activity feed
  • Email notifications using MailHog
  • Asynchronous task processing using Celery and Redis
  • Monitoring and management of Celery tasks using Flower
  • Containerized deployment using Docker and Docker Compose
  • Reverse proxy and load balancing using Nginx

Technologies

Prerequisites

Make sure you have the following technologies installed on your machine:

Getting Started

  1. Clone the repository:

    git clone https://github.com/benidevo/blogscribe.git
    
  2. Navigate to the project directory::

    cd blogscribe
    
  3. Build the Docker containers and start the application:

    make build
    
  4. Once the containers are built and the application is running, you can access the following resources:

    Documentation: Open your web browser and visit localhost:8080/redoc to access the API documentation.

    Flower (Celery monitoring): Open your web browser and visit localhost:5555 to access Flower, the monitoring and management tool for Celery tasks.

    MailHog (Email server): Open your web browser and visit localhost:8025 to access MailHog, the email testing tool. You can view the email notifications sent by the application here.

Additional Commands

The Makefile in the project contains other useful commands for managing the application. Some of the commonly used commands are:

Make sure to stop the application containers when you are done by running:

make down

blogscribe's People

Contributors

benidevo avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.