Palt

Palt is an application for reading books with interface for commenting and discussion by quotes.

Table of contents

• Table of contents
• Roadmap
• Installation
• Usage
  • Build system
  • Web application
• Wiki
• Authors

Installation

To run project, first clone the repo on your device using the command below:

git init

git clone https://github.com/DF5HSE/SE2021Practice.git

Make sure you have Python3 and pip installed on your device. Perform installation dependencies by running

python3 build-system-script.py install-depends

Usage

Build system

build-system-script.py -- is a script which help to run some routine operations and checks automatically. You can launch it by: python3 build-system-script.py <command>. Available commands are:

• install-depends -- install dependencies, listed in requirements.txt.
• type-check -- run mypy, which check matching of types in source python files.
• pylint -- run pylint linter above source files
• all-checks -- run all checks commands.

Web application

You can launch web application on your local host by command:

python3 -m uvicorn src:palt_app --reload

After that you can try out endpoints in your browser on http://127.0.0.1:8000/docs

Wiki

Documentation and other useful materials you can find in project wiki.

Project status

Project is in development. The first step is creating a web application, which is in progress now.

Roadmap

Roadmap for project can be found here.

Author

Denis Filippov (GitHub: DF5HSE)