Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
98 lines (65 loc) · 3.26 KB

CONTRIBUTING.md

File metadata and controls

98 lines (65 loc) · 3.26 KB

Contributing Guide

Introduction

Whether you're an experienced developer or this is your first open source contribution, we welcome your support! You can contribute to WesternFriend's project in various ways:

  • Design
  • Testing
  • Ideas
  • Accessibility
  • Writing code

For general discussions and to get involved with the community, visit our discussion area.

Development Setup

Follow the steps below to set up your development environment.

Prerequisites

Note: If you're using Windows, please use PowerShell. If your system uses the python3 command instead of python, substitute it as needed.

Optionally, install Claude context mode manager for better AI-assisted development using Claude Code:

/plugin marketplace add mksglu/claude-context-mode
/plugin install context-mode@claude-context-mode

Setup

  1. Clone the Repository: git clone git@github.com:WesternFriend/westernfriend.org.git

  2. Change into the Application Directory: cd westernfriend.org/

  3. Create Virtual Environment and Install Dependencies:

    uv sync

  4. Activate the Virtual Environment:

    • Mac/Linux: source .venv/bin/activate
    • Windows PowerShell: .venv\Scripts\Activate.ps1

  5. Activate Pre-Commit: pre-commit install

Running Background Services

This project uses Docker to manage a Postgres database.

  • Start the Database: docker compose up --detach
  • pgAdmin Access: Use localhost:5050 (credentials in the docker-compose.yaml file)

Application Configuration

  1. Create .env File (with DJANGO_DEBUG=true)
  2. Run Database Migrations: python manage.py migrate
  3. Create a Superuser: python manage.py createsuperuser
  4. Run the Server: python manage.py runserver (access from http://localhost:8000)
  5. Scaffold Initial Content: python manage.py scaffold_initial_content

To edit the Tailwind CSS, run the following command in a separate terminal:

python manage.py tailwind start

Dependency Management

We use UV for dependency management with dependencies defined in pyproject.toml. Use the following commands:

  • Install All Dependencies: uv sync
  • Install with Dev Dependencies: uv sync --all-extras
  • Update Dependencies: uv sync --upgrade
  • Add New Packages:
    • For regular dependencies: uv add <package-name>
    • For development dependencies: uv add --dev <package-name>
    • After adding packages, run uv sync to ensure your environment is up to date

Alternatives

Docker UI

If you prefer an alternative to Docker/Docker UI, try Colima.

  • Start Colima: colima start
  • If you face an error, use limactl stop -f colima, then re-run the start command.

Support

Need help? Feel free to open a support ticket.

Conclusion

We appreciate your interest and contribution to the WesternFriend project. Happy coding!