https://github.com/scriptogre/the-pyoneers-platform
A Django-based website and blog powered by Wagtail CMS and styled with TailwindCSS.
https://github.com/scriptogre/the-pyoneers-platform
Last synced: over 1 year ago
JSON representation
A Django-based website and blog powered by Wagtail CMS and styled with TailwindCSS.
- Host: GitHub
- URL: https://github.com/scriptogre/the-pyoneers-platform
- Owner: scriptogre
- Created: 2023-08-17T09:11:26.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2023-11-02T13:41:19.000Z (over 2 years ago)
- Last Synced: 2023-11-02T14:38:17.960Z (over 2 years ago)
- Language: CSS
- Size: 16 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# The Pyoneer Platform
Welcome to The Pyoneer Platform, the official platform for hosting The Pyoneer Project's courses. This project is built on top of Django and uses a variety of modern web technologies to provide a smooth and interactive learning experience.
## Live Platform
The live platform is accessible at [pyoneers.dev](https://pyoneers.dev).
## Technologies Used
- **Backend**: Django
- **Frontend**: TailwindCSS, HTMX, Hyperscript
- **Templating**: Jinja2
- **Authentication**: django-allauth (Google and Discord SSO included)
## Features
- Dynamic Course Creation and Management
- User Authentication including Social Login (Google and Discord)
- Interactive and Responsive UI with TailwindCSS and HTMX
- Extensible with Hyperscript
## Installation
1. Clone the repository:
```bash
git clone https://github.com/scriptogre/the-pyoneers-platform.git
```
2. Navigate to the project directory:
```bash
cd the-pyoneers-platform
```
3. Install the required packages:
```bash
pip install -r requirements.txt
```
4. Apply migrations:
```bash
python manage.py migrate
```
5. Create a superuser:
```bash
python manage.py createsuperuser
```
6. Set up the social apps for Google and Discord authentication:
```bash
python manage.py setup_social_apps
```
7. Run the server:
```bash
python manage.py runserver
```
Now, navigate to `http://localhost:8000` in your web browser.
### TailwindCSS Setup
We use TailwindCSS CLI for building the CSS. The command below compiles and watches for changes in files set as `content` from within `tailwind.config.js` file and minifies it to `output.min.css` which the `base.html` template looks for:
```bash
npx tailwindcss -i pyoneers_platform/static/css/src/input.css -o pyoneers_platform/static/css/output.css --watch --minify
```
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more information.