Pyramid app for issuing your own Open Badges
Go to file
Aurélien Bompard dc8e345355
Fix github action
Signed-off-by: Aurélien Bompard <aurelien@bompard.org>
2024-05-19 09:36:48 +02:00
.github Fix github action 2024-05-19 09:36:48 +02:00
.s2i/bin add s2i conf 2024-04-04 13:15:53 +10:00
devel Improve the ansible playbook/roles for Vagrant 2024-05-18 10:49:04 +02:00
docs Generic linting 2024-04-16 12:38:12 +02:00
fedora-sitedocs Update about.rst 2022-10-03 21:27:41 -04:00
logo Move logo media files from doc/ to logo/ to avoid confusion with Sphinx docs/ folder. 2013-07-25 10:59:20 -04:00
tahrir Linting fixes 2024-05-18 23:42:23 +02:00
tests Drop python2 compatibility bits 2024-04-16 12:38:12 +02:00
.gitignore Generic linting 2024-04-16 12:38:12 +02:00
.pre-commit-config.yaml Update pre-commit hook charliermarsh/ruff-pre-commit to v0.4.4 2024-05-13 05:04:10 +00:00
CHANGELOG.md Version 1.1.0 2024-05-19 09:29:28 +02:00
LICENSE Relicense to include additional permission. Fixes #44. 2013-05-20 16:00:46 -04:00
README.md Update README.md 2024-04-10 11:38:18 +10:00
Vagrantfile Deploy alembic.ini in Vagrant 2024-05-18 10:48:04 +02:00
poetry.lock Update tahrir-api 2024-05-19 09:28:46 +02:00
pyproject.toml Version 1.1.0 2024-05-19 09:29:28 +02:00
tox.ini clean out old files no longer needed or used 2024-04-08 17:56:13 +10:00

README.md

Tahrir

fedora-badges https://badges.fedoraproject.org/

Tahrir is an application used by the Fedora Project for issuing Open Badges. As per the about page:

The concept of Open Badges originated among those working at the Mozilla and MacArthur foundations, and out of the research of Erin Knight, founding director of the Open Badges project at Mozilla.

Originally, information was hosted on the Mozilla Wiki.

Tahrir is Arabic for Liberation

Contributing

Welcome! Thank you for taking the time to contribute. This project relies on an active and involved community, and we really appreciate your support.

Quickstart

  1. Look for an existing issue about the bug or feature you're interested in. If you can't find an existing issue, create a new one.

  2. Fork the repository on GitHub.

  3. Fix the bug or add the feature, and then write one or more tests which show the bug is fixed or the feature works.

  4. Submit a pull request and wait for a maintainer to review it.

More detailed guidelines to help ensure your submission goes smoothly are below.

Guidelines

Tests

The test suites can be run using tox by simply running tox from the repository root. We aim for all code to have test coverage or be explicitly marked as not covered using the # no-qa comment. We encourage the Test Driven Development Practice

Your pull request should contain tests for your new feature or bug fix. If you're not certain how to write tests, we will be happy to help you.

Setup a local development environment

To quickly start hacking on Tahrir, we provide a vagrant setup.

  1. Set up tinystage (if you haven't already) and ensure the base boxes are running.

    https://github.com/fedora-infra/tiny-stage

    This sets up the infrastructure to use things like authentication and Fedora Messaging when developing on Tahrir

  2. Clone the repository to your local storage and run

    vagrant up
    
  3. Tahrir frontend should now be available on https://badges.tinystage.test.