From c17c0c12d98f9ce2616524d7a02e421023d42dd7 Mon Sep 17 00:00:00 2001 From: Benjamin Kaiser Date: Sun, 27 Jan 2019 15:22:30 -0800 Subject: [PATCH] update README.md --- README.md | 53 ++++++++++++++++++++++++++++++++++++++++------------- 1 file changed, 40 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 39a9e826..16c44d30 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,46 @@ -Stretto (previously Node Music Player) +[Stretto](https://next.kaiserapps.com/) ================= #### An open source web-based music player [![Join the chat at https://gitter.im/benkaiser/stretto](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/benkaiser/stretto?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) -![screenshot](https://cloud.githubusercontent.com/assets/608054/12073955/0b9a34c6-b0ef-11e5-83f5-04c6f3fed33c.png) +![screenshot](https://user-images.githubusercontent.com/608054/51808037-8e79a200-2243-11e9-8275-6b2e34153e09.png) -This is an experimental branch with a newly developed version of Stretto. -Soon there will be a hosted version of this so no developer installation is -needed. +[Go to Stretto](https://next.kaiserapps.com/), or if you would like to host it yourself, scroll down to the developer instructions. -### Developer Instructions +## How does Stretto work? + +Stretto works by backing every single one of your tracks with a video or song from youtube or soundcloud, and plays them transparently through an iframe embedded on the page. + +Here is a list of some of the features Stretto has: + +- [Import your playlists from Spotify](https://next.kaiserapps.com/spotify/) +- [Syncing between machines](https://next.kaiserapps.com/sync/) (by logging in with Google, PRs welcome for other auth methods) +- Automatic lyric fetching for the currently playing song +- [Music discovery through iTunes/Spotify top charts](https://next.kaiserapps.com/discover) +- Search iTunes and add tracks to library seamlessly +- Multiple themes available. +- Completely free! +- [Android App](https://github.com/benkaiser/stretto-mobile-next/) + +![image](https://user-images.githubusercontent.com/608054/51808164-2d52ce00-2245-11e9-87d8-d55058c2ef3f.png) + +## Android App + +A basic Android application is in the works here: +https://github.com/benkaiser/stretto-mobile-next/ + + +## Developer Instructions + +Setup a .env file to setup your environment variables: + +``` +GOOGLE_CLIENT_ID=<...> +GOOGLE_CLIENT_ID_ANDROID=<...> +GOOGLE_API_KEY=<...> +SPOTIFY_CLIENT_ID=<...> +``` #### Running in Docker + Docker Compose @@ -18,7 +48,7 @@ needed. bin/go ``` -And you're done! Good to go! try it out on http://localhost:3000 +That's it! Go to http://localhost:3000 #### Without Docker @@ -26,12 +56,9 @@ You'll need: - Node.js 6 - Mongodb running -then execute +Add your MONGO_URL settings to your environment variables, then execute ``` yarn -npm run webpack -npm start -``` - -You can also pass the `MONGO_URL` environment variable to the process to set the correct redis instance. +npm run dev +``` \ No newline at end of file