Merge pull request #21 from ArcoMul/add-dev-instructions-to-readme

Add development instructions to README + fix .gitignore
This commit is contained in:
Daoud Clarke 2021-12-29 09:04:53 +00:00 committed by GitHub
commit 0b7bc90a05
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 11 additions and 1 deletions

2
.gitignore vendored
View file

@ -1,4 +1,4 @@
./data
/data
.idea
*~

View file

@ -111,3 +111,13 @@ If you would like to help in any of these or other ways, thank you!
Please join our [Matrix chat
server](https://matrix.to/#/#mwmbl:matrix.org) or email the main
author (email address is in the git commit history).
Development
===========
Using Docker:
1. Create a new folder called `data` in the root of the repository
2. Download the [index file](https://storage.googleapis.com/mwmbl/index.tinysearch) and place it the new data folder
3. Run `$ docker build . -t mwmbl`
4. Run `$ docker run -p 8080:8080 mwmbl`