An ebook/comic library service and web client
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
Drew Short d6c90024f2 Attempting to fix links 6 years ago
..
atheneum Pinned dev resources. 7 years ago
migrations Major quality of life changes 7 years ago
tests Validated patch mechanism works on User 7 years ago
.dockerignore Added basic repository documentation 6 years ago
.env Address renamed atheneum application 7 years ago
.pylintrc Working on integrating pylint and pydocstyle into the build process 7 years ago
CHANGELOG.md Added basic repository documentation 6 years ago
Dockerfile Added basic repository documentation 6 years ago
LICENSE Added error handlers to return APIResponse objects as JSON 7 years ago
Pipfile Fix pipenv dev dependencies and address pylint complaints 7 years ago
Pipfile.lock Pinned dev resources. 7 years ago
README.md Adding links to files 6 years ago
entrypoint.sh Address renamed atheneum application 7 years ago
manage.py Disable sessions 7 years ago
mypy.ini Address mypy complaints 7 years ago
run_tests.sh Attempting to resolve differences between CI and dev environment 7 years ago
setup.py server: initial commit with simple API for login, login_bump, logout 7 years ago
test_settings.py Add coverage reporting 7 years ago

README.md

Atheneum Server

Requirements

  • Python 3.6
  • Pipenv

Installation

git clone <repository>
cd <cloned repository>
pipenv install
pipenv shell

Configuration

Running

Docker

docker build -t atheneum:local-test .
docker run -d atheneum:local-test

Local Development Version

FLASK_APP=atheneum:atheneum flask run

FAQ

Development

pipenv install --dev
  • Make changes
  • Add/Update tests
./run_tests
  • If everything passes follow contributing guide.

Contributing

See ../CONTRIBUTING.md