Skip to content

Commit

Permalink
Update CONTRIBUTING.rst (#70)
Browse files Browse the repository at this point in the history
* Update CONTRIBUTING.rst

- added windows instructions
- added a few suggested areas of contribution
- mainly just testing a potential 'dev' workflow

* Update CONTRIBUTING.rst

---------

Co-authored-by: Matthew Foster Walsh <[email protected]>
  • Loading branch information
clg236 and mfosterw authored Mar 10, 2024
1 parent 37a9398 commit f5ab06d
Showing 1 changed file with 22 additions and 2 deletions.
24 changes: 22 additions & 2 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,12 @@ and additions you could make to the site itself, such as to this document,
which tells people nothing about how to contribute at the moment. Regardless of
how you choose contribute, as long as it is in good faith, I appreciate it.

Some ideas for contributions include:
- Adding a new app to the site
- Adding a new feature to an existing app
- Adding a new feature to the site
- Adding a new feature to the constitution


.. Adapted from https://cookiecutter-django.readthedocs.io/en/latest/developing-locally.html
Expand All @@ -40,17 +46,25 @@ Make sure to have the following on your host:

First things first.

#. Clone the repository::

$ git clone https://github.com/mfosterw/cookiestocracy.git
$ cd cookiestocracy

#. Create a virtualenv::

$ python3.12 -m venv <virtual env path>
or
$ conda create -n <virtual env name> python=3.12

#. Activate the virtualenv you have just created::

$ source <virtual env path>/bin/activate
or
$ conda activate <virtual env name>

#. Install development requirements::

$ cd <what you have entered as the project_slug at setup stage>
$ pip install -r requirements/local.txt
$ git init # A git repo is required for pre-commit to install
$ pre-commit install
Expand All @@ -76,7 +90,13 @@ First things first.

#. Set the environment variables for your database(s)::

$ export DATABASE_URL=postgres://postgres:<password>@127.0.0.1:5432/<DB name given to createdb>
MACOS:
$ export DATABASE_URL=postgres://postgres:<password>@127.0.0.1:5432/<slug_name>
# Optional: set broker URL if using Celery
$ export CELERY_BROKER_URL=redis://localhost:6379/0

WINDOWS:
$ set DATABASE_URL=postgres://postgres:<password>@127.0.0.1:5432/<slug_name>
# Optional: set broker URL if using Celery
$ export CELERY_BROKER_URL=redis://localhost:6379/0

Expand Down

0 comments on commit f5ab06d

Please sign in to comment.