dpaste/docs/installation.rst

30 lines
838 B
ReStructuredText
Raw Normal View History

2018-01-08 03:20:50 +11:00
==================================
Installation for local development
==================================
2014-02-21 20:44:37 +11:00
Ready to contribute? Here's how to set up `dpaste` for local development.
1. Fork the `dpaste` repo on GitHub.
2. Clone your fork locally::
$ git clone https://github.com/<your_username>/dpaste.git
2018-01-08 03:20:50 +11:00
3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper
installed, this is how you set up your fork for local development::
2014-02-21 20:44:37 +11:00
$ cd dpaste/
2018-01-08 03:20:50 +11:00
$ pipenv install --three --dev
2014-02-21 20:44:37 +11:00
2017-05-19 23:30:27 +10:00
4. Copy the settings file and edit it, to meet your needs::
$ cp dpaste/settings/local.py.example dpaste/settings/local.py
$ nano dpaste/settings/local.py
5. Initialze the database by running the command::
2014-02-21 20:44:37 +11:00
2018-01-08 03:20:50 +11:00
$ pipenv run ./manage.py migrate
2014-02-21 20:44:37 +11:00
2017-05-19 23:30:27 +10:00
6. Start up the webserver::
2014-02-21 20:44:37 +11:00
2018-01-08 03:20:50 +11:00
$ pipenv run ./manage.py runserver