Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 141 lines (83 sloc) 7.015 kb
fadfc89 Sudara Update README.markdown
authored
1 [![Build Status](https://secure.travis-ci.org/sudara/alonetone.png)](http://travis-ci.org/sudara/alonetone)
6cea8f9 Sudara Add code climate
authored
2 [![Code Climate](https://codeclimate.com/github/sudara/alonetone.png)](https://codeclimate.com/github/sudara/alonetone)
0af3234 Sudara alter readme to be more likely to be read
authored
3 ## The future is bright
4
8f28f71 Sudara Readme update
authored
5 [alonetone](http://alonetone.com) is an independent music platform, allowing musicians to host and distribute their music in a non-commercial, easy-to-use environment.
0af3234 Sudara alter readme to be more likely to be read
authored
6
030d4ef Sudara Test slack callback with README update
authored
7 alonetone launched in January 2008. As of 2015 it hosts over 58,000 tracks from 4500 musicians. We have delivered over 4.5 million mp3s to real listeners (not google and spambots, we are strict about excluding em!)
0af3234 Sudara alter readme to be more likely to be read
authored
8
9
e14bf2f Sudara
authored
10 ### Bug reporting
11
63e10e7 Sudara update ye olde readme
authored
12 We use [Github Issues](http://github.com/sudara/alonetone/issues) to submit bugs and keep track of our work.
e14bf2f Sudara
authored
13
63e10e7 Sudara update ye olde readme
authored
14 ### Our goal?
0af3234 Sudara alter readme to be more likely to be read
authored
15
8f28f71 Sudara Readme update
authored
16 To create and run the best online home a musician could want to have. To provide them with the tools they need to reach listeners and network with other artists — without the stank of commercialism, startup flava, ads, etc.
0af3234 Sudara alter readme to be more likely to be read
authored
17
8f28f71 Sudara Readme update
authored
18 We strive to build:
0af3234 Sudara alter readme to be more likely to be read
authored
19
8f28f71 Sudara Readme update
authored
20 * An easy to use, straightforward, intuitive, and consistent interface. Grandma-friendly (Yes, my grandma does use alonetone).
3241c64 Sudara Boots in rails 3. Deal with various startup time and config issues.
authored
21 * Attractive to look at. UI-first feature building. Designer always involved.
8f28f71 Sudara Readme update
authored
22 * An open-source rails app that is easy to setup, adheres to best practices and can serve as good example.
23 * Practical, useful tools and services for musicians — without too much clutter and junk (no facebook integration, etc)
24 * Encourage artist exploration and a sense of community: encouragement to stick around vs. cliqueyness
3241c64 Sudara Boots in rails 3. Deal with various startup time and config issues.
authored
25 * It does not overwhelm folks with TMI (too much information) or TMO (too many options) or TMF (too many features).
0af3234 Sudara alter readme to be more likely to be read
authored
26
8f28f71 Sudara Readme update
authored
27 New Features must prove themselves and obey the above principles — not just be built because it sounds cool or would be fun to hack on. We have said "no" to many "intuitive" or "easy" features like threaded comment replies because they would compromise or distract from the above goals.
28
29 For more info on alonetone, visit [the alonetone faq](http://alonetone.com/about)
0af3234 Sudara alter readme to be more likely to be read
authored
30
3241c64 Sudara Boots in rails 3. Deal with various startup time and config issues.
authored
31 ### Current tech
32
40181db wioux Update README.markdown
wioux authored
33 * Rails 4.2
3241c64 Sudara Boots in rails 3. Deal with various startup time and config issues.
authored
34 * jQuery
35 * SoundManager 2 (for flash + html5 playback)
36
37
0af3234 Sudara alter readme to be more likely to be read
authored
38 ### Current feature set
39
40 * Unlimited mp3 uploads for musicians
41 * Creation of playlists / albums
3241c64 Sudara Boots in rails 3. Deal with various startup time and config issues.
authored
42 * MP3 streaming and download (powered by amazon s3)
629c613 Sudara README update
authored
43 * Artist browsing
3241c64 Sudara Boots in rails 3. Deal with various startup time and config issues.
authored
44 * Track browsing by popularity, who you are following, most favorited, etc.
629c613 Sudara README update
authored
45 * Tracking of listens and providing useful feedback and statistics to artists
8f28f71 Sudara Readme update
authored
46 * One-way commenting system (No inline relpies. No threaded comments. No "pms")
6666235 Sudara update readme
authored
47 * Feeds for iTunes podcasts and offsite flash players
0af3234 Sudara alter readme to be more likely to be read
authored
48
601f273 Sudara Readme update
authored
49 ## Features wanted
0af3234 Sudara alter readme to be more likely to be read
authored
50
601f273 Sudara Readme update
authored
51 ### Browse All Playlists
d7a3a3c Sudara Upgrade all scopes to rails 3 scopes/methods.
authored
52 Low hanging fruit, boys and girls! Shoulda been a 2008 feature :)
53
601f273 Sudara Readme update
authored
54 ### On the fly zip downloads of playlists via nginx mod\_zip
d7a3a3c Sudara Upgrade all scopes to rails 3 scopes/methods.
authored
55 This is very easy. Already implemented on Ramen Music. Essentially just is a having a controller generate a text file of filenames that nginx interrupts and uses to construct a zip that's sent back to the client.
56
601f273 Sudara Readme update
authored
57 ### Better discovery though tags
58 It's high time. We're small fries perhaps (40k tracks) but we lack any categorization outside of playlists and users. The community has decided NO GENRES and after a bunch of discussion, we've decided going with tags (chosen by the uploader) is likely best. However, problems ensue, including:
59 1) If it's a free for all, won't it just be like genres, but messy?
60 2) Should the tags be moderated and exclude genres?
61 3) What to do about tagging all the old music, should moderators be able to adjust and add tags for the lazy users/old tracks?
62 4) Should there be a maximum enforced for UI purposes?
63
64 This is more than just programming, it's ultimately a UI issue. We can look to Ramen's tag implementation (4-5 maximum, taking up 1-2 lines) for inspiration, but it's very easy to do this wrong.
65
66 ### Better overall alonetone stats page.
d7a3a3c Sudara Upgrade all scopes to rails 3 scopes/methods.
authored
67 We need to expose a bit more info to the admins/mods. We want to see how signups/assets/comments are trending to help us catch anything strange or cool. But we also just want to know some useful stuff.
68
601f273 Sudara Readme update
authored
69 ### User stats page
d7a3a3c Sudara Upgrade all scopes to rails 3 scopes/methods.
authored
70 Partial implementation/proof of concept was working on rails 2 branch. Basically, a track-by-track table-view of listens, downloads, sources, etc, along with a graph over time for each track.
71
601f273 Sudara Readme update
authored
72 ### A way to manage blacklisted IPs in the backend.
d7a3a3c Sudara Upgrade all scopes to rails 3 scopes/methods.
authored
73 We get trouble with downloading bots, spambots. We have manually hardcoded IPs in the source, specefically to prevent downloading mp3 and wasting our bandwidth. We need to create a UI so this can be managed by a non-techie moderator. Also, we need to provide logged in users with a "report" action on their listens if they notice sketchy behavior, so it can go upstream to the mods.
74
601f273 Sudara Readme update
authored
75 ### Groups.
d7a3a3c Sudara Upgrade all scopes to rails 3 scopes/methods.
authored
76 Talk with Sudara about this. There's a partial half-hearted implementation.
77
eedc6c1 Sudara Readme: "This is not the script you are looking for"
authored
78
8f28f71 Sudara Readme update
authored
79 ### Remove alonetone branding from the code
80 It would be nice to separate the alonetone branding, email address, url, and so on — out into config files.
81
82 ## Want to deploy alonetone on your server?
eedc6c1 Sudara Readme: "This is not the script you are looking for"
authored
83
b1b8b09 Sudara update readme, rails4
authored
84 ![Sorry script kiddies](https://img.skitch.com/20120908-1exaxnmix5mb82xaq32tjnrja.png)
85
8f28f71 Sudara Readme update
authored
86 It's not going to happen unless:
eedc6c1 Sudara Readme: "This is not the script you are looking for"
authored
87
8f28f71 Sudara Readme update
authored
88 * You know ruby on rails well (Been doing it for more than a few months).
eedc6c1 Sudara Readme: "This is not the script you are looking for"
authored
89 * You have deployed rails applications, and are comfortable with that.
90 * You are willing to spend 20+ hours removing our branding and logo and site-specific things from the code.
91
74e38b0 Sudara typos
authored
92 We get a LOT of requests from rails n00bs asking if we can help them setup this "script" because they want an alonetone for a certain region of the world, or in another language.
eedc6c1 Sudara Readme: "This is not the script you are looking for"
authored
93
74e38b0 Sudara typos
authored
94 Please understand that alonetone is open-source as an educational tool, to encourage collaboration, and for transparency. It is not intended as a white-label solution. If you are serious about getting a copy in production, it's going to take lots of work (like 40+ hours) since it's not intended for that purpose.
eedc6c1 Sudara Readme: "This is not the script you are looking for"
authored
95
96 **If you still decide to try keep in mind we are unable to provide ANY support**
97
98 ## Want to help make alonetone.com awesome?
99
100 Sweet, now we are talkin'!
0af3234 Sudara alter readme to be more likely to be read
authored
101
63e10e7 Sudara update ye olde readme
authored
102 First, [sign up for an account](http://alonetone.com) and start digging in.
0af3234 Sudara alter readme to be more likely to be read
authored
103
63e10e7 Sudara update ye olde readme
authored
104 Second, hop into our Campfire chat room or email us at support@alonetone.com
6666235 Sudara update readme
authored
105
be22202 Sudara readme update
authored
106 Thirdly, fork away on github.
6666235 Sudara update readme
authored
107
ed65097 Sudara Get rid of tests/*, get config copying working, travis config
authored
108 ### Setup alonetone on localhost
be22202 Sudara readme update
authored
109
403fa86 Sudara readme
authored
110
87d05d8 Sudara update readme for 'rake setup'
authored
111 1) clone
403fa86 Sudara readme
authored
112
87d05d8 Sudara update readme for 'rake setup'
authored
113 2) bundle
403fa86 Sudara readme
authored
114
87d05d8 Sudara update readme for 'rake setup'
authored
115 3) Create needed config, database, and load db/seeds:
be22202 Sudara readme update
authored
116
87d05d8 Sudara update readme for 'rake setup'
authored
117 rake setup
118
119 4) rails s
0af3234 Sudara alter readme to be more likely to be read
authored
120
121
87d05d8 Sudara update readme for 'rake setup'
authored
122 Note: alonetone uses 3 config files that are created by 'rake setup'
ed65097 Sudara Get rid of tests/*, get config copying working, travis config
authored
123
0af3234 Sudara alter readme to be more likely to be read
authored
124
51562fa Kelly Fox gave the readme some TLC
kfox authored
125 alonetone.yml (contains the application "secret" and app-specific settings)
126 database.yml
127 newrelic.yml (for performance tracking)
697bd19 Alex Nguyen easier alonetone local setup
tiendung authored
128
cbbe760 Alex Nguyen better guideline
tiendung authored
129
51562fa Kelly Fox gave the readme some TLC
kfox authored
130 #### Logging in
cbbe760 Alex Nguyen better guideline
tiendung authored
131
8f28f71 Sudara Readme update
authored
132 After the bootstrap data is loaded, you can login using the test account. Username is "admin" and password is "testing123"
be22202 Sudara readme update
authored
133
51562fa Kelly Fox gave the readme some TLC
kfox authored
134 After login, click on the "Upload" button to upload your first mp3.
6b288f4 Sudara license stuff
authored
135
1c34cf0 Sudara README formatting (desperate for those commits, ya see)
authored
136 ## License
6b288f4 Sudara license stuff
authored
137
138 The alonetone source code is released under the MIT license.
139
8f28f71 Sudara Readme update
authored
140 "alonetone", "alonetone.com" and the alonetone logo are copyright Sudara Williams 2008-2013 and may not be used without permission.
Something went wrong with that request. Please try again.