Skip to content

Commit

Permalink
Initial
Browse files Browse the repository at this point in the history
Create CODE_OF_CONDUCT.md

Add funding guidelines

Add contributing guidelines

Update README.md

Add dependabot config

Add github actions ci

Create LICENSE

Change donate url

Update FUNDING.yml

Add default values for env

Explicitly assign default value

Add more default values

Fix fallback

Use sqlite in tests; change to simpleJWT

Disable CI for now

Bump zipp from 3.19.2 to 3.20.0

Bumps [zipp](https://github.com/jaraco/zipp) from 3.19.2 to 3.20.0.
- [Release notes](https://github.com/jaraco/zipp/releases)
- [Changelog](https://github.com/jaraco/zipp/blob/main/NEWS.rst)
- [Commits](jaraco/zipp@v3.19.2...v3.20.0)

---
updated-dependencies:
- dependency-name: zipp
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>

Bump cloudinary from 1.40.0 to 1.41.0

Bumps [cloudinary](https://github.com/cloudinary/pycloudinary) from 1.40.0 to 1.41.0.
- [Release notes](https://github.com/cloudinary/pycloudinary/releases)
- [Changelog](https://github.com/cloudinary/pycloudinary/blob/master/CHANGELOG.md)
- [Commits](cloudinary/pycloudinary@1.40.0...1.41.0)

---
updated-dependencies:
- dependency-name: cloudinary
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>

Bump boto3 from 1.34.147 to 1.35.4

Bumps [boto3](https://github.com/boto/boto3) from 1.34.147 to 1.35.4.
- [Release notes](https://github.com/boto/boto3/releases)
- [Commits](boto/boto3@1.34.147...1.35.4)

---
updated-dependencies:
- dependency-name: boto3
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>

Bump pyfcm from 1.5.4 to 2.0.6

Bumps [pyfcm](https://github.com/olucurious/pyfcm) from 1.5.4 to 2.0.6.
- [Release notes](https://github.com/olucurious/pyfcm/releases)
- [Changelog](https://github.com/olucurious/PyFCM/blob/master/CHANGES.rst)
- [Commits](olucurious/PyFCM@1.5.4...2.0.6)

---
updated-dependencies:
- dependency-name: pyfcm
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <[email protected]>

Change default password

Remove youtube api key
  • Loading branch information
n2o committed Aug 26, 2024
0 parents commit 52af190
Show file tree
Hide file tree
Showing 714 changed files with 96,265 additions and 0 deletions.
4 changes: 4 additions & 0 deletions .dockerignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
.run/
.venv/
.venv.bak/
data/
58 changes: 58 additions & 0 deletions .env.example
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
# db
DB_NAME=
DB_USER=
DB_PWD=
DB_HOST=
DB_PORT=

DEBUG=True
LOG_LEVEL=DEBUG

AIEDN_API_TOKEN=
AIEDN_API_URL=

CLOUDINARY_URL=
GOOGLE_APPLICATION_CREDENTIALS=
YOUTUBE_API_KEY=

# app
DOMAIN=
API_DOMAIN=

ALLOWED_HOSTS=localhost

# Services
FIREBASE_SERVER_KEY=
SENDGRID_KEY=
SECRET_KEY=
TWILIO_ACCOUNT_SID=
TWILIO_AUTH_TOKEN=

TUTORING_ENABLED=True

# social keys
SOCIAL_AUTH_GOOGLE_OAUTH2_KEY=
SOCIAL_AUTH_GOOGLE_OAUTH2_SECRET=

AWS_STORAGE_BUCKET_NAME=
AWS_ACCESS_KEY_ID=
AWS_SECRET_ACCESS_KEY=

SOCIAL_AUTH_FACEBOOK_KEY=
SOCIAL_AUTH_FACEBOOK_SECRET=

COMPRESS_OUTPUT_DIR=cache
PAYPAL_CLIENT_ID=
PAYPAL_SECRET_ID=

GLOBAL_WSS_URL=
WEBSOCKET_QUESTION_PUSH_DOMAIN_BASE=
WEBSOCKET_USER_PUSH_DOMAIN_BASE=

REDIS_SENTINEL_1=
REDIS_SENTINEL_1_PORT=
REDIS_SENTINEL_2=
REDIS_SENTINEL_2_PORT=
REDIS_PASSWORD=

COOKIE_NAME=session_dv
16 changes: 16 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
version: 2
updates:
- package-ecosystem: "docker"
directory: "/"
schedule:
interval: "weekly"

- package-ecosystem: "pip"
directory: "/"
schedule:
interval: "weekly"

- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "weekly"
21 changes: 21 additions & 0 deletions .github/test.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
name: Django
on: [push]

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Install poetry
run: pipx install poetry
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: 3.12
cache: "poetry"
- name: Install dependencies
run: |
pip install poetry
poetry install
- name: Test
run: poetry run python manage.py test
14 changes: 14 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
*.pyc
*/static/*
*/media/*
.idea/*
.env
restart.sh
error_log*
.DS_Store
log/*
*.log
data/
.tool-versions
.venv/
venv/
91 changes: 91 additions & 0 deletions .gitlab-ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
before_script:
- docker login -u gitlab-ci-token -p $CI_JOB_TOKEN $CI_REGISTRY

stages:
- build
- deploy

build-sit:
stage: build
tags:
- sit
script:
- docker build -t registry.gitlab.com/new-learning/mathefragen.de/app:$CI_COMMIT_TAG .
- docker push registry.gitlab.com/new-learning/mathefragen.de/app:$CI_COMMIT_TAG
only:
- /^[0-9]+(?:.[0-9]+)+[a-z]*-sit$/
except:
- branches

#deploy-sit:
# stage: deploy
# tags:
# - sit
# script:
# - docker service update --with-registry-auth --image registry.gitlab.com/new-learning/mathefragen.de/app:$CI_COMMIT_TAG --force math_mathefragen-server
# - docker service update --with-registry-auth --image registry.gitlab.com/new-learning/mathefragen.de/app:$CI_COMMIT_TAG --force api-mathe_mathefragen-server
# only:
# - /^[0-9]+(?:.[0-9]+)+[a-z]*-sit$/
# except:
# - branches

build-prod:
stage: build
tags:
- prod
script:
- docker build -t registry.gitlab.com/new-learning/mathefragen.de/app:$CI_COMMIT_TAG .
- docker push registry.gitlab.com/new-learning/mathefragen.de/app:$CI_COMMIT_TAG
only:
- /^[0-9]+(?:.[0-9]+)+$/
except:
- branches

deploy-prod:
stage: deploy
tags:
- prod
script:
- docker service update --with-registry-auth --image registry.gitlab.com/new-learning/mathefragen.de/app:$CI_COMMIT_TAG --force bio_biofragen-server
- docker service update --with-registry-auth --image registry.gitlab.com/new-learning/mathefragen.de/app:$CI_COMMIT_TAG --force chemi_chemiefragen-server
- docker service update --with-registry-auth --image registry.gitlab.com/new-learning/mathefragen.de/app:$CI_COMMIT_TAG --force informatic_informatikfragen-server
- docker service update --with-registry-auth --image registry.gitlab.com/new-learning/mathefragen.de/app:$CI_COMMIT_TAG --force math_mathefragen-server
- docker service update --with-registry-auth --image registry.gitlab.com/new-learning/mathefragen.de/app:$CI_COMMIT_TAG --force meta_metafragen-server
- docker service update --with-registry-auth --image registry.gitlab.com/new-learning/mathefragen.de/app:$CI_COMMIT_TAG --force physik_physikfragen-server
only:
- /^[0-9]+(?:.[0-9]+)+$/
except:
- branches

#default:
# image: debian:10
# services:
# - postgres:11.7
# - redis:latest
# cache:
# paths:
# - ~/.cache/pip/
# before_script:
# - apt -y update
# - apt -y install apt-utils
# - apt -y install net-tools python3 python3-pip
# - apt -y install postgresql postgresql-contrib
# - apt -y upgrade
# - pip3 install -r requirements.txt
#
#
#migrations:
# stage: build
# script:
# - python3 manage.py makemigrations
# - python3 manage.py migrate
# - python3 manage.py check
#
#
#django-tests:
# stage: test
# script:
# # - python3 manage.py test, we need to solve this migration issue later on once we start writing new tests
# # django.db.utils.ProgrammingError: relation "user_review" does not exist
# - python3 manage.py check
#
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
<component name="ProjectRunConfigurationManager">
<configuration default="false" name="docker-compose.yml[django, postgres, redis, redis-sentinel]: Compose Deployment" type="docker-deploy" factoryName="docker-compose.yml" server-name="Docker">
<deployment type="docker-compose.yml">
<settings>
<option name="envFilePath" value="" />
<option name="services">
<list>
<option value="django" />
<option value="postgres" />
<option value="redis" />
<option value="redis-sentinel" />
</list>
</option>
<option name="sourceFilePath" value="docker-compose.yml" />
<option name="upDetach" value="false" />
</settings>
</deployment>
<method v="2" />
</configuration>
</component>
128 changes: 128 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,128 @@
# Contributor Covenant Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, religion, or sexual identity
and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our
community include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the
overall community

Examples of unacceptable behavior include:

* The use of sexualized language or imagery, and sexual attention or
advances of any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email
address, without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
[email protected].
All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series
of actions.

**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or
permanent ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within
the community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.0, available at
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.

Community Impact Guidelines were inspired by [Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity).

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at
https://www.contributor-covenant.org/translations.
26 changes: 26 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Contributing to mathefragen.de

We want to make contributing to this project as easy and transparent as
possible.

## Pull Requests

We actively welcome your pull requests.

1. Fork the repo and create your branch from `main`.
2. If you've added code that should be tested, add tests. (Hint: Logic should always be tested)
3. If you've changed APIs, update the documentation.
4. Ensure the test suite passes.
5. Make sure your code lints.

## Issues

We use GitHub issues to track public bugs. Please ensure your description is
clear and has sufficient instructions to be able to reproduce the issue.

If you don't know where to start, check tagged [good first issues](https://github.com/mathebydanieljung/mathefragen.de/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22).

## License

By contributing to schnaq, you agree that your contributions will be licensed
under the LICENSE file in the root directory of this source tree.
Loading

0 comments on commit 52af190

Please sign in to comment.