Update README.md
This commit is contained in:
parent
d4687a72cc
commit
87970a254f
1 changed files with 8 additions and 33 deletions
41
README.md
41
README.md
|
@ -616,12 +616,9 @@ All contributions to ArchiveBox are welcomed! Check our [issues](https://github.
|
||||||
Low hanging fruit / easy first tickets:<br/>
|
Low hanging fruit / easy first tickets:<br/>
|
||||||
<a href="https://lgtm.com/projects/g/ArchiveBox/ArchiveBox/alerts/"><img alt="Total alerts" src="https://img.shields.io/lgtm/alerts/g/ArchiveBox/ArchiveBox.svg?logo=lgtm&logoWidth=18"/></a>
|
<a href="https://lgtm.com/projects/g/ArchiveBox/ArchiveBox/alerts/"><img alt="Total alerts" src="https://img.shields.io/lgtm/alerts/g/ArchiveBox/ArchiveBox.svg?logo=lgtm&logoWidth=18"/></a>
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>
|
|
||||||
|
|
||||||
### Setup the dev environment
|
### Setup the dev environment
|
||||||
|
|
||||||
</summary>
|
<details><summary><i>Click to expand...</i></summary>
|
||||||
|
|
||||||
#### 1. Clone the main code repo (making sure to pull the submodules as well)
|
#### 1. Clone the main code repo (making sure to pull the submodules as well)
|
||||||
|
|
||||||
|
@ -672,13 +669,9 @@ docker run -it -p 8000:8000 \
|
||||||
See the `./bin/` folder and read the source of the bash scripts within.
|
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`.
|
You can also run all these in Docker. For more examples see the Github Actions CI/CD tests that are run: `.github/workflows/*.yaml`.
|
||||||
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>
|
|
||||||
|
|
||||||
#### Run in DEBUG mode
|
#### Run in DEBUG mode
|
||||||
|
|
||||||
</summary>
|
<details><summary><i>Click to expand...</i></summary>
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
archivebox config --set DEBUG=True
|
archivebox config --set DEBUG=True
|
||||||
|
@ -688,12 +681,9 @@ archivebox server --debug ...
|
||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>
|
|
||||||
|
|
||||||
#### Build and run a Github branch
|
#### Build and run a Github branch
|
||||||
|
|
||||||
</summary>
|
<details><summary><i>Click to expand...</i></summary>
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
docker build -t archivebox:dev https://github.com/ArchiveBox/ArchiveBox.git#dev
|
docker build -t archivebox:dev https://github.com/ArchiveBox/ArchiveBox.git#dev
|
||||||
|
@ -702,12 +692,9 @@ docker run -it -v $PWD:/data archivebox:dev ...
|
||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>
|
|
||||||
|
|
||||||
#### Run the linters
|
#### Run the linters
|
||||||
|
|
||||||
</summary>
|
<details><summary><i>Click to expand...</i></summary>
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
./bin/lint.sh
|
./bin/lint.sh
|
||||||
|
@ -716,12 +703,9 @@ docker run -it -v $PWD:/data archivebox:dev ...
|
||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>
|
|
||||||
|
|
||||||
#### Run the integration tests
|
#### Run the integration tests
|
||||||
|
|
||||||
</summary>
|
<details><summary><i>Click to expand...</i></summary>
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
./bin/test.sh
|
./bin/test.sh
|
||||||
|
@ -730,12 +714,9 @@ docker run -it -v $PWD:/data archivebox:dev ...
|
||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>
|
|
||||||
|
|
||||||
#### Make migrations or enter a django shell
|
#### Make migrations or enter a django shell
|
||||||
|
|
||||||
</summary>
|
<details><summary><i>Click to expand...</i></summary>
|
||||||
|
|
||||||
Make sure to run this whenever you change things in `models.py`.
|
Make sure to run this whenever you change things in `models.py`.
|
||||||
```bash
|
```bash
|
||||||
|
@ -750,12 +731,9 @@ archivebox manage dbshell
|
||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>
|
|
||||||
|
|
||||||
#### Build the docs, pip package, and docker image
|
#### Build the docs, pip package, and docker image
|
||||||
|
|
||||||
</summary>
|
<details><summary><i>Click to expand...</i></summary>
|
||||||
|
|
||||||
(Normally CI takes care of this, but these scripts can be run to do it manually)
|
(Normally CI takes care of this, but these scripts can be run to do it manually)
|
||||||
```bash
|
```bash
|
||||||
|
@ -771,12 +749,9 @@ archivebox manage dbshell
|
||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>
|
|
||||||
|
|
||||||
#### Roll a release
|
#### Roll a release
|
||||||
|
|
||||||
</summary>
|
<details><summary><i>Click to expand...</i></summary>
|
||||||
|
|
||||||
(Normally CI takes care of this, but these scripts can be run to do it manually)
|
(Normally CI takes care of this, but these scripts can be run to do it manually)
|
||||||
```bash
|
```bash
|
||||||
|
|
Loading…
Reference in a new issue