Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ashermorgan committed Apr 20, 2024
1 parent a1f53be commit be8dda6
Showing 1 changed file with 9 additions and 8 deletions.
17 changes: 9 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,22 @@
# Songs2Slides
An easy-to-use tool that automatically finds song lyrics and creates lyric slideshows
A tool that automatically finds song lyrics and creates lyric slideshows

## Setup
1. Install python dependencies
Install Python dependencies:
```
python3 -m pip install -r requirements.txt
```

2. Add variables to `.env` file
Add API environment variables to a `.env` file:
```
# Song lyric API with {title} and {artist} placeholders
API_URL="http://example.com/get-lyrics?title={title}&artist={artist}"
API_AUTH="Bearer secrettoken" # Optional
# Optional API authentication header
API_AUTH="Bearer secrettoken"
```

3. Run app in debug mode
Run Songs2Slides on [localhost:5000](http://localhost:5000)
```
flask --app songs2slides run --debug
flask --app songs2slides run
```

4. Visit [localhost:5000](http://localhost:5000)

0 comments on commit be8dda6

Please sign in to comment.