Browse Source

Improve installation instructions

readme
Kevin Mok 5 years ago
parent
commit
d8e4b0f6dd
Signed by: Kevin-Mok GPG Key ID: AEA75288DC135CF5
  1. 72
      README.md
  2. 9
      scripts/queries/most-played.sql

72
README.md

@ -8,47 +8,51 @@ These instructions will get you a copy of the project up and running on your loc
### Prerequisites
Before starting the setup, make sure Python 3 and PostgreSQL is installed on your system.
- Python 3
- `pip`
- PostgreSQL
#### On Debian/Ubunu
``` shell
sudo apt-get install python3-pip
sudo apt-get install postgresql
sudo apt-get install python-psycopg2
sudo apt-get install libpq-dev
pip install --user virtualenv
```
<!--- installation steps {{{ -->
### Installing
1. Use the pip tool to install `virtualenv`. See this [guide](http://docs.python-guide.org/en/latest/dev/virtualenvs/) for further details.
1. Create a virtual environment.
``` shell
virtualenv /path/to/new/virtual/environment
```
```
pip install --user pipenv
```
2. Create a virtual environment.
```
python3 -m venv /path/to/new/virtual/environment
```
3. `cd` into the directory you just created a virtual environment in,
1. `cd` into the directory you just created a virtual environment in,
and clone the GitHub repo:
```
cd /path/to/new/virtual/environment
git clone https://github.com/Kevin-Mok/spotify-lib-vis
```
4. Activate the virtual environment from the command line.
```
# activate.fish if you're using fish shell
source bin/activate
```
5. `cd` into the repository root directory and install all
dependencies using `pip`.
```
cd spotify-lib-vis
pip install -r requirements.txt
```
6. Run `reset_db.sh` to create the database and start the server.
```
./scripts/reset_db.sh
```
``` shell
cd /path/to/new/virtual/environment
git clone https://github.com/Kevin-Mok/spotify-lib-vis
```
1. Activate the virtual environment from the command line.
``` shell
# activate.fish if you're using fish shell
source bin/activate
```
1. `cd` into the repository root directory and install all dependencies using `pip`.
``` shell
cd spotify-lib-vis
pip3 install -r requirements.txt
```
1. Run `reset_db.sh` to create the database and start the server.
``` shell
./scripts/reset_db.sh
```
<!--- }}} installation steps -->

9
scripts/queries/most-played.sql

@ -1,5 +1,6 @@
-- select t.name as track, a.name as artist
select substring(t.name for 50) as track, a.name as artist, count(t.id)
select distinct on (1)
timestamp, substring(t.name for 50) as track, a.name as artist
from api_history as h
join api_track as t
on h.track_id = t.id
@ -7,6 +8,6 @@ join api_track_artists ta
on ta.track_id = t.id
join api_artist a
on a.id = ta.artist_id
group by t.id, a.id
order by count(t.id) desc;
-- limit 10;
order by timestamp desc
-- ;
limit 20;
|||||||
100:0
Loading…
Cancel
Save