opentech.fund Wagtail site

Contributing

1. Make changes on a new branch, including a broad category and the ticket number if relevant e.g. feature/123-extra-squiggles, fix/newsletter-signup.
2. Push your branch to the remote.
3. Edit details as necessary.

If you need to preview work on staging, this can be merged and deployed manually without making a merge request. You can still make the merge request as above, but add a note to say that this is on staging, and not yet ready to be merged to master.

Setting up a local build

This repository includes a Vagrantfile for running the project in a Debian VM.

To set up a new build:

git clone git@github.com:OpenTechFund/opentech.fund.git
cd opentech.fund
vagrant up
vagrant ssh

Then within the SSH session:

dj migrate
dj createcachetable
dj createsuperuser
djrun

This will make the site available on the host machine at: http://127.0.0.1:8000/

Updating front-end files

Any changes made to sass or js files will need to be recompiled using:

yarn build

Alternatively you can run the watcher that will rebuild on change to files:

yarn start

Both commands should be run from within the opentech/static_src folder in the vagrant box.