From f4111cc264f96074cc1e5b9be8cc6dd5e73ee516 Mon Sep 17 00:00:00 2001 From: ztimson Date: Thu, 14 Dec 2023 19:06:07 -0500 Subject: [PATCH] Updated readme, legal & ci/cd --- .github/workflows/build.yaml | 14 +++++ Dockerfile | 2 + LICENSE | 11 ++++ README.md | 101 +++++++++++++++++++++++++++++++---- docker-compose.yml | 5 +- 5 files changed, 121 insertions(+), 12 deletions(-) create mode 100644 .github/workflows/build.yaml create mode 100644 LICENSE diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml new file mode 100644 index 0000000..aae85d3 --- /dev/null +++ b/.github/workflows/build.yaml @@ -0,0 +1,14 @@ +name: Build +run-name: Build + +on: + push: + +jobs: + publish: + name: Build & Push Dockerfile + uses: ztimson/actions/.github/workflows/docker.yaml@develop + with: + name: ztimson/oacpl + repository: ${{github.server_url}}/${{github.repository}}.git + pass: ${{secrets.DEPLOY_TOKEN}} diff --git a/Dockerfile b/Dockerfile index c888643..216f93b 100644 --- a/Dockerfile +++ b/Dockerfile @@ -18,3 +18,5 @@ RUN python3 manage.py migrate --no-input RUN python3 manage.py collectstatic --no-input EXPOSE 8000 +ENTRYPOINT python3 +CMD ["manage.py", "runserver", "0.0.0.0:8000"] diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..6b3783a --- /dev/null +++ b/LICENSE @@ -0,0 +1,11 @@ +Copyright (c) 2023 Zakary Timson + +All Rights Reserved. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. diff --git a/README.md b/README.md index 23c2a6e..843172b 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,95 @@ -# OACPL + +
+
-[See Live](https://oacpl.org/) + + Logo + + + ### OACPL + + + Ontario Association of Child Protection Lawyers + + + [![Version](https://img.shields.io/badge/dynamic/json.svg?label=Version&style=for-the-badge&url=https://git.zakscode.com/api/v1/repos/ztimson/oacpl/tags&query=$[0].name)](https://git.zakscode.com/ztimson/oacpl/tags) + [![Pull Requests](https://img.shields.io/badge/dynamic/json.svg?label=Pull%20Requests&style=for-the-badge&url=https://git.zakscode.com/api/v1/repos/ztimson/oacpl&query=open_pr_counter)](https://git.zakscode.com/ztimson/oacpl/pulls) + [![Issues](https://img.shields.io/badge/dynamic/json.svg?label=Issues&style=for-the-badge&url=https://git.zakscode.com/api/v1/repos/ztimson/oacpl&query=open_issues_count)](https://git.zakscode.com/ztimson/oacpl/issues) + + + + --- +
+ Release Notes + • Report a Bug + • Request a Feature +
+ + --- +
+ +## Table of Contents +- [OACPL](#top) + - [About](#about) + - [Built With](#built-with) + - [Setup](#setup) + - [Production](#production) + - [Development](#development) + - [License](#license) + +## About A Django website for the Ontario Ascociation of Child Protection Lawyers which not only acts as a landing page for the non-profit but also provides the following services: - - Member enrollment - - FAQ Forumn so the public can ask registered lawyers questions - - Events with optional registration - - Newsletters & press releases - - Case law directory allowing lawyers to quickly search and find president for cases - - An expert lookup directory so that lawyers can research expert witnesses before putting them on the stand - + +- Member enrollment & profile pages +- Public FAQ forum to ask registered lawyers questions +- Event calendar & registration +- Newsletters & press releases +- Case law directory allowing lawyers to quickly search and find president for cases +- An expert lookup directory so that lawyers can research expert witnesses before putting them on the stand + +### Built With +[![Django](https://img.shields.io/badge/django-0C4B33?style=for-the-badge&logo=django)](https://www.djangoproject.com/) +[![Docker](https://img.shields.io/badge/Docker-384d54?style=for-the-badge&logo=docker)](https://docker.com/) +[![Python](https://img.shields.io/badge/Python-FFD43B?style=for-the-badge&logo=python)](https://www.python.org/) + +## Setup + +
+ +

+ Production +

+ + +#### Prerequisites +- [Docker](https://docs.docker.com/install/) + +#### Instructions +1. Run the docker image: `docker run -p 80:8000 git.zakscode.com/ztimson/oacpl:latest` +2. Open [http://localhost](http://localhost) +
+ +
+ +

+ Development +

+ + +#### Prerequisites +- [Python](https://www.python.org/downloads/) + +#### Instructions +1. Install the dependencies: `pip install -r requirements.txt` +2. Run database migrations: `python3 manage.py makemigrations && python3 manage.py migrate` +3. Collect static files: `python3 manage.py collectstatic` +4. Start server: `python3 manage.py runserver 0.0.0.0:8000` +5. Open http://localhost:8000 + +
+ +## License +Copyright © 2023 Zakary Timson | All Rights Reserved + +See the [license](./LICENSE) for more information. diff --git a/docker-compose.yml b/docker-compose.yml index 6d43f01..f2928d8 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -1,13 +1,12 @@ -version: '3' +version: '3.8' services: - db: image: postgres web: + image: git.zakscode.com/ztimson/oacpl:latest build: . - command: python3 manage.py runserver 0.0.0.0:8000 volumes: - .:/code ports: