pyopensci-django

A repository to migrate the pyOpenSci Jekyll site to Django with Wagtail CMS

Prerequisites

Before setting up the project locally, make sure you have the following installed:

• First, install uv - Install uv
• Then make sure you have Python 3.12+ installed. You can install it using uv:

$ uv python install 3.12

• Node.js - Download from nodejs.org (for TailwindCSS)

Local Development Setup

1. Set Up Python Environment with uv

# Install all dependencies and create virtual environment
uv sync

# Install Node.js packages for TailwindCSS
npm install

2. Build CSS and Set Up Database

# Build TailwindCSS stylesheets
npm run build-prod

# Run migrations using uv
uv run python manage.py migrate

3. Create an admin user (optional)

If you want to try out the Django Admin dashboard or Wagtail dashboard, create a superuser (admin) account which can be used for Django Admin and Wagtail:

# Create superuser (optional - for admin access)
uv run python manage.py createsuperuser

4. Run Development Server

# Start Django development server
uv run python manage.py runserver

Testing the Homepage Migration

• Homepage (Django): http://127.0.0.1:8000
• Blog (Wagtail): http://127.0.0.1:8000/blog/
• Wagtail Admin: http://127.0.0.1:8000/cms/
• Django Admin: http://127.0.0.1:8000/admin/

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Philip Narteh 💻 👀

This project follows the all-contributors specification. Contributions of any kind welcome!