https://github.com/dahlitzflorian/personal-bookshelf

A web application representing a personal bookshelf allowing multi-user usage.
https://github.com/dahlitzflorian/personal-bookshelf

bookshelf docker docker-compose docker-image flask flask-application python python-3 python3

Last synced: about 1 month ago
JSON representation

A web application representing a personal bookshelf allowing multi-user usage.

• Host: GitHub
• URL: https://github.com/dahlitzflorian/personal-bookshelf
• Owner: DahlitzFlorian
• License: apache-2.0
• Created: 2019-02-08T18:39:54.000Z (about 6 years ago)
• Default Branch: develop
• Last Pushed: 2019-03-16T21:51:48.000Z (almost 6 years ago)
• Last Synced: 2024-11-11T00:25:27.812Z (3 months ago)
• Topics: bookshelf, docker, docker-compose, docker-image, flask, flask-application, python, python-3, python3
• Language: Python
• Size: 13.7 KB
• Stars: 1
• Watchers: 4
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Personal Bookshelf

[![Build Status](https://dev.azure.com/fdahlitz/personal-bookshelf/_apis/build/status/DahlitzFlorian.personal-bookshelf?branchName=master)](https://dev.azure.com/fdahlitz/personal-bookshelf/_build/latest?definitionId=3&branchName=master)

![black](https://img.shields.io/badge/code%20style-black-000000.svg)

## Description

Represents a personal bookshelf allowing the multi-user usage.

## Install

To install this project on your machine for development, clone the repository and go to the

projects directory. Optionally, you can create a virtual environment to keep things clean.

After that run:

```bash

$ python -m pip install -e .

```

## Test

To run the tests, you need to install additional dependencies (you may do it inside of a

virtual environment) and run the tests:

```bash

$ python -m pip install '.[test]'

$ pytest

```

## Status

Currently in development.

## Contributing

If you are interested in contributing, please check out the [CONTRIBUTING.md](CONTRIBUTING.md).

There you find information about the commit and branch naming conventions as well as about the

general Gitflow.

[tox]: https://tox.readthedocs.io/en/latest/