warricksothr
/
Atheneum
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
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.
79 Commits
3 Branches
0 Tags
255 KiB
 
 
 
 
Tree: acb431ca60
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'acb431ca60'
${ noResults }
Atheneum/server
Drew Short acb431ca60
Merge branch 'development' into 'master' 		6 years ago
..
atheneum Added paginated user endpoint 6 years ago
documentation Adding sphinxjsondomain to document json objects 6 years ago
migrations Major quality of life changes 7 years ago
tests Added paginated user endpoint 6 years ago
.dockerignore Add basic sphinx documentation scaffold 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 Adding sphinxjsondomain to document json objects 6 years ago
Pipfile.lock Adding sphinxjsondomain to document json objects 6 years ago
README.md Adding GitLab pages integration 6 years ago
entrypoint.sh Address renamed atheneum application 7 years ago
manage.py Finish documentation work for 2018.8.1 6 years ago
mypy.ini Address mypy complaints 7 years ago
run_tests.sh Finish documentation work for 2018.8.1 6 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

API Documentation

Requirements

  • Python 3.6
  • Pipenv

Installation

git clone https://gitlab.com/WarrickSothr/Atheneum.git
cd Atheneum/server
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 db upgrade
python manage.py user register-admin
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