Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Testok #37

Closed
wants to merge 7 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/integration-tests.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: API Testing

on: [pull_request, push, workflow_dispatch]
on: [workflow_call, workflow_dispatch]

jobs:
test:
Expand Down
23 changes: 23 additions & 0 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: CI / CD

on:
push:
branches:
- main
pull_request:
workflow_dispatch:

jobs:
test:
uses: ./.github/workflows/integration-tests.yml

build-and-push:
if: github.ref == 'refs/heads/main'
needs: test
permissions:
contents: read
packages: write
uses: ./.github/workflows/publish-and-deploy.yml
with:
REGISTRY: ghcr.io
IMAGE_NAME: ${{ github.repository }}
38 changes: 38 additions & 0 deletions .github/workflows/publish-and-deploy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
name: Build and publish Docker image

on:
workflow_call:
inputs:
REGISTRY:
type: string
required: true
IMAGE_NAME:
type: string
required: true

jobs:
build-and-push-image:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v3
- name: Log in to GHCR
uses: docker/login-action@v2
with:
registry: ${{ inputs.REGISTRY }}
username: ${{ github.actor }}
password: ${{ secrets.GITHUB_TOKEN }}
- name: Extract tags and labels for Docker image
id: meta
uses: docker/metadata-action@v4
with:
images: ${{ inputs.REGISTRY }}/${{ inputs.IMAGE_NAME }}
- name: Set up Docker Buildx
uses: docker/setup-buildx-action@v2
- name: Build and push Docker image
uses: docker/build-push-action@v4
with:
context: .
push: true
tags: ${{ steps.meta.outputs.tags }}
labels: ${{ steps.meta.outputs.labels }}
48 changes: 1 addition & 47 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,47 +1 @@
# GamingRealm Backend
[![API Testing](https://github.com/idkbrowby/gamingrealm-backend/actions/workflows/integration-tests.yml/badge.svg)](https://github.com/idkbrowby/gamingrealm-backend/actions/workflows/integration-tests.yml)
## Architecture
TODO: fill this in

## Developing
This project uses the [Poetry](https://python-poetry.org) package manager.
After installing poetry, run
```bash
poetry install
```
in this directory to install all dependencies. Then, run
```bash
poetry run pre-commit install
```
to install the git pre-commit hooks. To manually trigger linting, run `poetry run task lint`.

The following steps will differ depending on whether you have PostgreSQL installed locally.
### Local PostgreSQL
1) Set the `GR_DATABASE_URL` environment variable (or make a file called `.env` in this directory and make it);
set it to your database connection URL.
2) Run
```bash
poetry run prisma generate
poetry run prisma migrate dev
```

### You don't have PostgreSQL installed
Just use our Docker container for development
```bash
docker compose up
```

## Running the server
Run
```bash
poetry run task runserver
```

## Running tests
Run
```bash
poetry run task test
```

## Database Structure
[ER Diagram](https://dbdiagram.io/embed/635aaaa96848d85eee878aea)
TEST TEST