add dev setup

Author: copelco

README.md

@@ -4,27 +4,78 @@ A plugin for deploying Django projects to PythonAnywhere, using django-simple-de
 
 For full documentation, see the documentation for [django-simple-deploy](https://django-simple-deploy.readthedocs.io/en/latest/).
 
+## Quickstart
+
+Deployment to [PythonAnywhere](https://www.pythonanywhere.com/) with this plugin
+requires a few prerequisites:
+
+- You must use Git to track your project and push your code to a remote
+  repository (e.g. GitHub, GitLab, Bitbucket).
+- You must track dependencies with a `requirements.txt` file.
+- Create a PythonAnywhere [Beginner account](https://www.pythonanywhere.com/registration/register/beginner/),
+  which is a limited account with one web app, but requires no credit card.
+- Generate an [API token](https://help.pythonanywhere.com/pages/GettingYourAPIToken)
+- Ideally, stay logged in to PythonAnywhere in your default browser to make the
+  first deployment smoother.
+
 ## Plugin Development
 
-To set up a development environment for working on this plugin alongside `django-simple-deploy`, follow these steps:
+To set up a development environment for working on this plugin alongside
+`django-simple-deploy`, follow these steps.
+
+1. Create a parent directory to hold your development work:
 
 ```sh
-# Create parent dir to hold development work
 mkdir dsd-dev
 cd dsd-dev/
+```
+
+2. Clone `dsd-pythonanywhere` for development:
+
+```sh
+# Clone dsd-pythonanywhere for development (and switch to branch being worked on)
+git clone [email protected]:caktus/dsd-pythonanywhere.git --branch add-api-client
+```
 
-# Clone dsd-pythonanywhere for development
-git clone [email protected]:caktus/dsd-pythonanywhere.git
-cd dsd-pythonanywhere/
-# switch to branch being worked on
-git checkout add-api-client
+3. Clone `django-simple-deploy` and create the blog sample project
 
-# Clone django-simple-deploy and set up development environment
+```sh
 git clone [email protected]:django-simple-deploy/django-simple-deploy.git
 cd django-simple-deploy/
-uv venv
-uv pip install -e ".[dev]"
-uv add --editable "../[dev]"
-uv pip install -e "../dsd-pythonanywhere/[dev]"
-uv run pytest tests/unit_tests
+# Builds a copy of the sample project in parent dir for testing (../dsd-dev-project-[random_string]/)
+uv run python tests/e2e_tests/utils/build_dev_env.py
+```
+
+4. Setup the development environment:
+
+```sh
+cd ../
+cd dsd-dev-project-[random_string]/
+source .venv/bin/activate
+# Install dsd-pythonanywhere plugin in editable mode
+pip install -e "../dsd-pythonanywhere/[dev]"
+```
+
+5. Create a [new public repository on GitHub](https://github.com/new).
+
+6. Push the sample project to your new repository:
+
+```sh
+git remote add origin [email protected]:[your_github_username]/[your_new_repo_name].git
+git branch -M main
+git push -u origin main
+```
+
+7. Configure environment variables for PythonAnywhere API access:
+
+```sh
+export API_USER=[your_pythonanywhere_username]
+export API_TOKEN=[your_pythonanywhere_api_token]
+```
+
+8. You can now make changes to `dsd-pythonanywhere` in the cloned directory
+and test them by running deployments from the sample project:
+
+```sh
+python manage.py deploy
 ```