Mirrors/ArchiveBox
2
0
Fork 0
mirror of https://github.com/ArchiveBox/ArchiveBox synced 2024-11-10 06:34:16 +00:00
Code Issues Projects Releases Packages Wiki Activity

Update README.md

Browse source
This commit is contained in:
Nick Sweeting 2021-01-30 02:38:44 -05:00 committed by GitHub
parent ab0aec1507
commit cddbd8f63e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -639,6 +639,13 @@ archivebox config --set DEBUG=True
archivebox server --debug ... 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 #### Run the linters
```bash ```bash
@ -655,6 +662,7 @@ archivebox server --debug ...
#### Make migrations or enter a django shell #### Make migrations or enter a django shell
Make sure to run this whenever you change things in `models.py`.
```bash ```bash
cd archivebox/ cd archivebox/
./manage.py makemigrations ./manage.py makemigrations
@ -666,6 +674,7 @@ archivebox shell
#### Build the docs, pip package, and docker image #### 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 ```bash
./bin/build.sh ./bin/build.sh
@ -679,6 +688,7 @@ archivebox shell
#### Roll a release #### Roll a release
(Normally CI takes care of this, but these scripts can be run to do it manually)
```bash ```bash
./bin/release.sh ./bin/release.sh