Skip to content

Commit

Permalink
Move DEVELOPING.md into main readme
Browse files Browse the repository at this point in the history
Signed-off-by: Ryan Lerch <[email protected]>
  • Loading branch information
ryanlerch committed Apr 8, 2024
1 parent b9b18cd commit 676ef19
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 37 deletions.
37 changes: 0 additions & 37 deletions DEVELOPING.md

This file was deleted.

30 changes: 30 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,36 @@ running ``tox`` from the repository root. We aim for all code to have test cover

Your pull request should contain tests for your new feature or bug fix. If you're not certain how to write tests, we will be happy to help you.

#### Setup a local development environment

To quickly start hacking on tahrir we provide a vagrant setup.

First, install Ansible, Vagrant, the vagrant-sshfs plugin, and the vagrant-libvirt plugin from the official Fedora repos

```
$ sudo dnf install ansible vagrant vagrant-libvirt vagrant-sshfs
```

Now, from within main directory (the one with the Vagrantfile in it) of your git checkout of tahrir, copy the Vagrantfile.example file to Vagrantfile

```
$ cp Vagrantfile.example Vagrantfile
```

Run the ``vagrant up`` command to provision your dev environment

```
$ vagrant up
```

When this command is completed (it may take a while) start tahrir with the following command:

```
$ vagrant ssh -c"cd /vagrant/; pserve --reload development.ini"
```

Once that is running, simply go to http://localhost:8000/ in your browser on your host to see your running tahrir test instance.

[open-badges]: https://openbadges.org
[ob-about]: https://openbadges.org/about/
[moz-badges]: https://wiki.mozilla.org/index.php?title=Badges&oldid=1170927
Expand Down

0 comments on commit 676ef19

Please sign in to comment.