{"id":27720576,"url":"https://github.com/cameroncthomas/teachmestem","last_synced_at":"2026-04-18T04:33:26.185Z","repository":{"id":288634577,"uuid":"968752838","full_name":"cameroncthomas/teachmestem","owner":"cameroncthomas","description":"Django web app for an education platform that provides resources, materials, and tools to help students prepare for their exams.","archived":false,"fork":false,"pushed_at":"2025-11-13T20:54:33.000Z","size":1131,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-11-13T22:24:38.804Z","etag":null,"topics":["allauth","bootstrap","django","django-allauth","htmx","mathjax","mjml","oauth2","python","recaptcha","smtp","whitenoise"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cameroncthomas.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-04-18T17:05:35.000Z","updated_at":"2025-11-13T20:54:37.000Z","dependencies_parsed_at":"2025-09-09T20:19:43.979Z","dependency_job_id":"18c9307f-13c9-4784-a2e9-adc0857a47a1","html_url":"https://github.com/cameroncthomas/teachmestem","commit_stats":null,"previous_names":["cameroncthomas/teachmestem"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/cameroncthomas/teachmestem","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cameroncthomas%2Fteachmestem","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cameroncthomas%2Fteachmestem/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cameroncthomas%2Fteachmestem/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cameroncthomas%2Fteachmestem/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cameroncthomas","download_url":"https://codeload.github.com/cameroncthomas/teachmestem/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cameroncthomas%2Fteachmestem/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31956999,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-18T00:39:45.007Z","status":"online","status_checked_at":"2026-04-18T02:00:07.018Z","response_time":103,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["allauth","bootstrap","django","django-allauth","htmx","mathjax","mjml","oauth2","python","recaptcha","smtp","whitenoise"],"created_at":"2025-04-27T09:57:51.590Z","updated_at":"2026-04-18T04:33:26.158Z","avatar_url":"https://github.com/cameroncthomas.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# TeachMeSTEM\n\n\u003cimg alt=\"teachmestem logo\" src=\"staticfiles/images/teachmestem.svg\" width=\"400\" height=\"170\"\u003e\n\n[![code style](https://img.shields.io/badge/code_style-black-black)](https://github.com/psf/black)\n[![imports](https://img.shields.io/badge/imports-isort-blue)](https://github.com/PyCQA/isort)\n[![python](https://img.shields.io/badge/python-3.10_|_3.11_|_3.12_|_3.13-ffde75)](https://github.com/python/cpython)\n[![django](https://img.shields.io/badge/django-5.2-0c4b32)](https://github.com/django/django)\n[![CI](https://github.com/cameroncthomas/teachmestem/actions/workflows/ci.yml/badge.svg)](https://github.com/cameroncthomas/teachmestem/actions/workflows/ci.yml)\n[![Coverage Status](https://coveralls.io/repos/github/cameroncthomas/teachmestem/badge.svg?branch=main)](https://coveralls.io/github/cameroncthomas/teachmestem?branch=main)\n\n\u003cbr\u003e\n\nDjango web app for an education platform that provides resources, materials, and tools to help students prepare for their exams.\n\n\u003cbr\u003e\n\nSome features include:\n\n- 🔑 User registration and authentication via email or social account (e.g. Google)\n- 📝 Upload and view revision notes, questions, model answers, and past papers\n- 📐 Beautiful MathJax notes complete with worked example sections\n- 📈 Track and evaluate progress by marking topics and past papers as complete\n- 📍 Pick out subjects currently studying for quick access to revision material and overall progress\n- 💌 Responsive HTML emails for account management (e.g. verification and forgotten password)\n- 🚢 Easy-to-navigate and intuitive UI\n\n\u003cbr\u003e\n\nTechnologies used:\n\n- Web framework: [`Django`](https://www.djangoproject.com/)\n- Styling: [`Bootstrap`](https://getbootstrap.com/)\n- Interactivity: [`htmx`](https://htmx.org/)\n- Authentication: [`django-allauth`](https://allauth.org/)\n- Static files: [`WhiteNoise`](https://github.com/evansd/whitenoise)\n- Bot protection: [`Django reCAPTCHA`](https://github.com/django-recaptcha/django-recaptcha)\n- Email service: [`SendGrid SMTP`](https://sendgrid.com/)\n- Email templates: [`MJML`](https://mjml.io/)\n- Maths text: [`MathJax`](https://www.mathjax.org/)\n\n\u003cbr\u003e\n\u003cbr\u003e\n\n\u003cimg width=\"49%\" alt=\"navigate to exam board from home page\" src=\"https://github.com/user-attachments/assets/b2db8f76-3505-4327-989c-8ae3a3fea0cb\"/\u003e\n\u003cimg width=\"49%\" alt=\"complete topics in exam board\" src=\"https://github.com/user-attachments/assets/369955e8-1c59-4b61-81b5-cbae197103bf\"/\u003e\n\u003cimg width=\"49%\" alt=\"display revision notes and worked examples\" src=\"https://github.com/user-attachments/assets/dcf5c18d-6c48-49e4-8a16-ab2de00879b6\"/\u003e\n\u003cimg width=\"49%\" alt=\"add subject to my subjects\" src=\"https://github.com/user-attachments/assets/28f14c6d-1aae-4fc7-9e7d-8e97bbb8fd32\"/\u003e\n\u003cimg width=\"49%\" alt=\"sign up form\" src=\"https://github.com/user-attachments/assets/1c0d6dcd-0040-489a-b5f2-0a135cf3fbd4\" /\u003e\n\u003cimg width=\"49%\" alt=\"verification email\" src=\"https://github.com/user-attachments/assets/3a737182-4cfd-4d5e-a1a7-934478b35e60\" /\u003e\n\n## How to run locally\n\nClone the repo and install the dependencies in a virtual environment:\n\n```\npip install -r requirements.txt\n```\n\nYou will need to add some environment variables too. These are `DEBUG`, `SECRET_KEY`, `SECURE_SSL_REDIRECT`, `RECAPTCHA_PUBLIC_KEY`, `RECAPTCHA_PRIVATE_KEY`, and `SENDGRID_API_KEY`.\n\nIf running in development, you will probably want to set `DEBUG = True` and `SECURE_SSL_REDIRECT = False`. The `RECAPTCHA_PUBLIC_KEY`, `RECAPTCHA_PRIVATE_KEY`, and `SENDGRID_API_KEY` keys can be generated by signing up for [reCAPTCHA](https://cloud.google.com/security/products/recaptcha) and [SendGrid](https://sendgrid.com/) respectively.\n\nNow apply the migrations to the database:\n\n```\npython manage.py migrate\n```\n\nFinally, create a superuser for access to the admin site:\n\n```\npython manage.py createsuperuser\n```\n\nYou are now ready to run the development web server:\n\n```\npython manage.py runserver\n```\n\nEnjoy!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcameroncthomas%2Fteachmestem","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcameroncthomas%2Fteachmestem","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcameroncthomas%2Fteachmestem/lists"}