Giter Club home page Giter Club logo

mangalibrary's Introduction

MangaLibrary

Simple manga (Japanese Comics) reader application written on Flask with Postgres database.

Screenshots Index page:

index page

User profile:

user profile

Manga page:

manga page

Chapter page:

chapter page

Features

  • user profile, user subscriptions, user statistics, user rating
  • manga, chapter, manga subscriptions , tags, comments
  • post news, popular discussions
  • administrator moderate users and comments
  • send email using queue

Technologies

  1. Server: Python Flask
  2. Database: Postgres
  3. Message-broker: RabbitMQ
  4. Task queue: Celery

Environment

These environment variables are needed to run the site

MAIL_USERNAME=
MAIL_PASSWORD=
MANGA_MAIL_SENDER=
RECAPTCHA_PUBLIC_KEY=
RECAPTCHA_PRIVATE_KEY=
FLASK_APP=
FLASK_CONFIG=
POSTGRES_USER=
POSTGRES_PASSWORD=
POSTGRES_DB=
SQLALCHEMY_DATABASE_URI=
SECRET_KEY =

Docker

git clone https://github.com/JC5LZiy3HVfV5ux/MangaLibrary.git
cd MangaLibrary

Set environments

Set Bootstrap 5

sudo docker-compose up

Installation

git clone https://github.com/JC5LZiy3HVfV5ux/MangaLibrary.git
cd MangaLibrary
python3 -m venv env
source env/bin/activate
pip install -r requirements.txt

Set environments

Create databases

If SQLALCHEMY_DATABASE_URI is empty, then it will be created SQLite database

python3 db_create.py

Bootstrap

Download Bootstrap 5 and add folders in app/static/js/bootstrap/, app/static/css/bootstrap/

Run application

flask run

Celery & RabbitMQ

Tasks:

  • task.email.change_email
  • task.email.confirm
  • task.email.password_reset

Run worker for queue email

celery -A worker.celery worker --loglevel=INFO -Q email

Run Flower for worker

celery -A worker.celery flower

Run RabbitMQ server

sudo rabbitmq-server start -detached

Testing

Run unittest:

flask test

Run unittest using test_names:

flask test tests.test_basics   

Obtaining code coverage reports:

flask test --coverage

mangalibrary's People

Contributors

tuankiri avatar

Stargazers

 avatar

Watchers

 avatar

Forkers

arthurthekingz

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.