From d4687a72cc2912199dffd124ecd8808f80848423 Mon Sep 17 00:00:00 2001 From: Nick Sweeting Date: Thu, 8 Apr 2021 06:01:04 -0400 Subject: [PATCH] Update README.md --- README.md | 61 ++++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 60 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e8ceb271..fbf1489b 100644 --- a/README.md +++ b/README.md @@ -616,8 +616,13 @@ All contributions to ArchiveBox are welcomed! Check our [issues](https://github. Low hanging fruit / easy first tickets:
Total alerts +
+ + ### Setup the dev environment + + #### 1. Clone the main code repo (making sure to pull the submodules as well) ```bash @@ -660,42 +665,78 @@ docker run -it -p 8000:8000 \ # (remove the --reload flag and add the --nothreading flag when profiling with the django debug toolbar) ``` +
+ ### Common development tasks See the `./bin/` folder and read the source of the bash scripts within. You can also run all these in Docker. For more examples see the Github Actions CI/CD tests that are run: `.github/workflows/*.yaml`. + +
+ + #### Run in DEBUG mode + + ```bash archivebox config --set DEBUG=True # or archivebox server --debug ... ``` +
+ +
+ + #### Build and run a Github branch + + ```bash docker build -t archivebox:dev https://github.com/ArchiveBox/ArchiveBox.git#dev docker run -it -v $PWD:/data archivebox:dev ... ``` +
+ +
+ + #### Run the linters + + ```bash ./bin/lint.sh ``` (uses `flake8` and `mypy`) +
+ +
+ + #### Run the integration tests + + ```bash ./bin/test.sh ``` (uses `pytest -s`) +
+ +
+ + #### Make migrations or enter a django shell + + Make sure to run this whenever you change things in `models.py`. ```bash cd archivebox/ @@ -707,8 +748,15 @@ archivebox manage dbshell ``` (uses `pytest -s`) +
+ +
+ + #### Build the docs, pip package, and docker image + + (Normally CI takes care of this, but these scripts can be run to do it manually) ```bash ./bin/build.sh @@ -721,8 +769,15 @@ archivebox manage dbshell ./bin/build_docker.sh ``` +
+ +
+ + #### Roll a release + + (Normally CI takes care of this, but these scripts can be run to do it manually) ```bash ./bin/release.sh @@ -735,7 +790,11 @@ archivebox manage dbshell ./bin/release_docker.sh ``` -### ArchiveBox Resources +
+ +--- + +## More ArchiveBox Resources - Main site: https://archivebox.io (via Github Pages) - Demo site: https://demo.archivebox.io (hosted by Monadical.com)