pyatl / big-peach

Big Peach is the PyATL meetup management system
MIT License
4 stars 8 forks source link

Build Status

big-peach

Big Peach is the PyATL meetup management system

Setup for local development

Downloading the Code

Creating a Virtual Environment

OSX / Linux

Create a new virtual environment by running python3 -m venv .venv

Then run: source .venv/bin/activate

Windows

Run: c:\>python -m venv c:\path\to\myenv

Documentation: https://docs.python.org/3/library/venv.html#creating-virtual-environments

Running the App

Before you add a new feature

Please open an issue or explain the issue in our discord server (https://discord.gg/5UBnR3P) The last thing we want is to waste your time :)

Running the tests

The unit tests use Django's test runner. The linter is flake8.

Happy coding!

Front end development

Enabling django-patterm-library

On your .env file add (if not already existing):

ENABLE_PATTERN_LIBRARY=on

The django-pattern-library is found at http://127.0.0.1:8000/pattern-library/

Please make sure to work on the front end on the pattern library first and commit changes.

Workflow:

Design -> Mockup -> Component -> Test -> Copy to templates