spotify-lib-vis/README.md

# Spotify Data Visualizer

See charts of the artists, genres and features of tracks in your library. Also keep track of your listening history.

## Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

### Prerequisites

- 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. Create a virtual environment.
    ``` shell
    virtualenv /path/to/new/virtual/environment
    ```

1. `cd` into the directory you just created a virtual environment in, 
and clone the GitHub repo:
    ``` 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 --> 

## Built With

* [Django](https://www.djangoproject.com/)
* [Spotify Web API](https://github.com/spotify/web-api)
* [pip packages used](requirements.txt)

## Authors

* [Kevin Mok](https://github.com/Kevin-Mok)
* [Chris Shyi](https://github.com/chrisshyi)

## License

This project is licensed under the GPL License - see the [LICENSE.md](LICENSE.md) file for details.