Browse Source

Wrote README

master
Kevin Mok 5 years ago
parent
commit
1a3686c282
Signed by: Kevin-Mok GPG Key ID: AEA75288DC135CF5
  1. 70
      README.md
  2. 27
      environment_setup.md
  3. 2
      update-history.service

70
README.md

@ -0,0 +1,70 @@
# 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
Before starting the setup, make sure Python 3.6 and PostgreSQL is installed on your system.
<!--- 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.
```
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, and clone the GitHub repo.
4. Activate the virtual environment from the command line.
```
source bin/activate
```
5. `cd` into the repository root directory and install all dependencies using `pip`.
```
pip install -r requirements.txt
```
6. Run Django migrations.
```
manage.py migrate
```
7. Start the server.
```
python manage.py runserver
```
<!--- }}} 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.

27
environment_setup.md

@ -1,27 +0,0 @@
Before starting the setup, make sure **Python 3.6** is installed on your system.
1. Use the pip tool to install `virtualenv`. (See this [guide](http://docs.python-guide.org/en/latest/dev/virtualenvs/) for further details.)
`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, and clone the GitHub repo.
4. Activate the virtual environment from the command line.
`source bin/activate`
5. `cd` into the repository root directory and install all dependencies using `pip`.
`pip install -r requirements.txt`
6. Run Django migrations.
`python manage.py migrate`
7. Start the server.
`python manage.py runserver`

2
update-history.service

@ -6,7 +6,7 @@ StartLimitIntervalSec=0
[Service]
Type=simple
Restart=always
RestartSec=300
RestartSec="15m"
User=kevin
ExecStart=/usr/bin/bash /home/kevin/coding/spotify-lib-vis/src/update-history.sh

Loading…
Cancel
Save