Browse Source

Added basic repository documentation

merge-requests/1/head
Drew Short 6 years ago
parent
commit
b91dff8b97
  1. 4
      .dockerignore
  2. 6
      CONTRIBUTING.md
  3. 23
      Dockerfile
  4. 40
      README.md
  5. 11
      server/.dockerignore
  6. 0
      server/CHANGELOG.md
  7. 4
      server/Dockerfile
  8. 53
      server/README.md

4
.dockerignore

@ -1,4 +0,0 @@
server/instance/
server/setup.py
server/test/
.admin_credentials

6
CONTRIBUTING.md

@ -0,0 +1,6 @@
# Contributing
* Fork the repository
* Make changes
* Test everything
* Open issue and attach patchfile for changes

23
Dockerfile

@ -1,23 +0,0 @@
FROM python:3.6-slim-stretch
MAINTAINER Drew Short <warrick@sothr.com>
ENV ATHENEUM_APP_DIRECTORY /opt/atheneum
ENV ATHENEUM_CONFIG_DIRECTORY /srv/atheneum/config
ENV ATHENEUM_DATA_DIRECTORY /srv/atheneum/data
RUN mkdir -p ${ATHENEUM_APP_DIRECTORY} \
&& mkdir -p ${ATHENEUM_CONFIG_DIRECTORY} \
&& mkdir -p ${ATHENEUM_DATA_DIRECTORY} \
&& pip install pipenv gunicorn
VOLUME ${ATHENEUM_CONFIG_DIRECTORY}
VOLUME ${ATHENEUM_DATA_DIRECTORY}
COPY ./server/ ${ATHENEUM_APP_DIRECTORY}/
RUN cd ${ATHENEUM_APP_DIRECTORY} \
&& pipenv install --system --deploy --ignore-pipfile
WORKDIR ${ATHENEUM_APP_DIRECTORY}
CMD ./entrypoint.sh

40
README.md

@ -0,0 +1,40 @@
# Atheneum
An ebook/comic library service and web client.
## Parts
### Server
The core API server
More information available at server/README.md
### Client
The primary SPA frontend
More information available at client/README.md
### Administration
The administration SPA.
More information available at administration/README.md
## Release History
## Changelog
See:
* server/CHANGELOG.md
* client/CHANGELOG.md
* administration/CHANGELOG.md
## FAQ
* TODO
## Maintainers
* Drew Short <warrick(AT)sothr(DOT)com>

11
server/.dockerignore

@ -0,0 +1,11 @@
.admin_credentials
.coverage
.pylintrc
mypy.ini
run_tests.sh
setup.py
test_settings.py
.mypy_cache/
.pytest_cache/
instance/
tests/

0
server/CHANGELOG.md

4
server/Dockerfile

@ -13,11 +13,13 @@ RUN mkdir -p ${ATHENEUM_APP_DIRECTORY} \
VOLUME ${ATHENEUM_CONFIG_DIRECTORY} VOLUME ${ATHENEUM_CONFIG_DIRECTORY}
VOLUME ${ATHENEUM_DATA_DIRECTORY} VOLUME ${ATHENEUM_DATA_DIRECTORY}
COPY ./server/ ${ATHENEUM_APP_DIRECTORY}/
COPY ./ ${ATHENEUM_APP_DIRECTORY}/
RUN cd ${ATHENEUM_APP_DIRECTORY} \ RUN cd ${ATHENEUM_APP_DIRECTORY} \
&& pipenv install --system --deploy --ignore-pipfile && pipenv install --system --deploy --ignore-pipfile
EXPOSE 8080
WORKDIR ${ATHENEUM_APP_DIRECTORY} WORKDIR ${ATHENEUM_APP_DIRECTORY}
CMD ./entrypoint.sh CMD ./entrypoint.sh

53
server/README.md

@ -0,0 +1,53 @@
# Atheneum Server
## Requirements
* Python 3.6
* Pipenv
## Installation
```bash
git clone <repository>
cd <cloned repository>
pipenv install
pipenv shell
```
## Configuration
## Running
### Docker
```bash
docker build -t atheneum:local-test .
docker run -d atheneum:local-test
```
### Local Development Version
```bash
FLASK_APP=atheneum:atheneum flask run
```
## FAQ
## Development
```bash
pipenv install --dev
```
* Make changes
* Add/Update tests
```bash
./run_tests
```
* If everything passes follow contributing guide.
## Contributing
See ../CONTRIBUTING.md
Loading…
Cancel
Save