Skip to content

Commit

Permalink
Add License notice and do some other doc updates
Browse files Browse the repository at this point in the history
  • Loading branch information
paramsingh committed Jun 24, 2017
1 parent b9f14f9 commit 7846c2a
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 7 deletions.
19 changes: 13 additions & 6 deletions HACKING.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,29 +6,36 @@ Here are some notes for short-cuts to get useful things done while hacking on Li

To open a Redis command prompt:

docker exec -it docker_redis_1 redis-cli
docker exec -it listenbrainz_redis_1 redis-cli


### Influx

To open an Influxdb command prompt:

docker exec -it docker_influx_1 influx
docker exec -it listenbrainz_influx_1 influx

and to drop all the listens in influx db:

use listenbrainz
drop measurement listen
drop database listenbrainz

After dropping the database, you'll probably need to create the database again:

create database listenbrainz


### Postgres

To get a postgres command prompt:

docker exec -it docker_web_1 psql -U listenbrainz -h db listenbrainz
docker exec -it listenbrainz_web_1 psql -U listenbrainz -h db listenbrainz

### Tests

To run the unit tests:

docker exec -it docker_web_1 py.test
./test.sh

To run the integration tests:

./integration-test.sh
27 changes: 26 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,13 +59,17 @@ ListenBrainz home page.

### Running tests

In order to run the tests for ListenBrainz, simply run:
In order to run the unit tests for ListenBrainz, simply run:

$ ./test.sh

This will build and run the containers needed to run the tests. Each of these containers will not use volumes
that link to data outside of the containers and thus will not interfere with production databases.

Also, run the integrations tests for ListenBrainz using the following command:

$ ./integration-test.sh


## Documentation

Expand All @@ -75,3 +79,24 @@ You can build the documentation yourself:
$ cd ~/listenbrainz/docs
$ make clean html

## License Notice

```
listenbrainz-server - Server for the ListenBrainz project.
Copyright (C) 2017 MetaBrainz Foundation Inc.
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
```

0 comments on commit 7846c2a

Please sign in to comment.