Skip to content
This repository
Newer
Older
100644 143 lines (85 sloc) 7.193 kb
fadfc892 »
2013-09-12 Update README.markdown
1 [![Build Status](https://secure.travis-ci.org/sudara/alonetone.png)](http://travis-ci.org/sudara/alonetone)
6cea8f9d »
2013-09-12 Add code climate
2 [![Code Climate](https://codeclimate.com/github/sudara/alonetone.png)](https://codeclimate.com/github/sudara/alonetone)
0af32347 »
2008-03-11 alter readme to be more likely to be read
3 ## The future is bright
4
8f28f710 »
2013-09-22 Readme update
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.
0af32347 »
2008-03-11 alter readme to be more likely to be read
6
8f28f710 »
2013-09-22 Readme update
7 alonetone launched in January 2008. As of 2013 it hosts over 50,000 songs from almost 4000 musicians. We have delivered over 3 million mp3s to real listeners (not google and spambots!)
0af32347 »
2008-03-11 alter readme to be more likely to be read
8
63e10e7c »
2011-09-13 update ye olde readme
9 ## Give us some dev love
6666235f »
2008-05-30 update readme
10
3241c646 »
2012-09-06 Boots in rails 3. Deal with various startup time and config issues.
11 Warm the hearts of musicians worldwide by working the *only* open-source rails app that provides musicians with a free home, a connection to each other and their friends/listeners.
0af32347 »
2008-03-11 alter readme to be more likely to be read
12
e14bf2f1 »
2008-10-19
13 ### Bug reporting
14
63e10e7c »
2011-09-13 update ye olde readme
15 We use [Github Issues](http://github.com/sudara/alonetone/issues) to submit bugs and keep track of our work.
e14bf2f1 »
2008-10-19
16
63e10e7c »
2011-09-13 update ye olde readme
17 ### Our goal?
0af32347 »
2008-03-11 alter readme to be more likely to be read
18
8f28f710 »
2013-09-22 Readme update
19 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.
0af32347 »
2008-03-11 alter readme to be more likely to be read
20
8f28f710 »
2013-09-22 Readme update
21 We strive to build:
0af32347 »
2008-03-11 alter readme to be more likely to be read
22
8f28f710 »
2013-09-22 Readme update
23 * An easy to use, straightforward, intuitive, and consistent interface. Grandma-friendly (Yes, my grandma does use alonetone).
3241c646 »
2012-09-06 Boots in rails 3. Deal with various startup time and config issues.
24 * Attractive to look at. UI-first feature building. Designer always involved.
8f28f710 »
2013-09-22 Readme update
25 * An open-source rails app that is easy to setup, adheres to best practices and can serve as good example.
26 * Practical, useful tools and services for musicians — without too much clutter and junk (no facebook integration, etc)
27 * Encourage artist exploration and a sense of community: encouragement to stick around vs. cliqueyness
3241c646 »
2012-09-06 Boots in rails 3. Deal with various startup time and config issues.
28 * It does not overwhelm folks with TMI (too much information) or TMO (too many options) or TMF (too many features).
0af32347 »
2008-03-11 alter readme to be more likely to be read
29
8f28f710 »
2013-09-22 Readme update
30 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.
31
32 For more info on alonetone, visit [the alonetone faq](http://alonetone.com/about)
0af32347 »
2008-03-11 alter readme to be more likely to be read
33
3241c646 »
2012-09-06 Boots in rails 3. Deal with various startup time and config issues.
34 ### Current tech
35
8f28f710 »
2013-09-22 Readme update
36 * Rails 4.0
3241c646 »
2012-09-06 Boots in rails 3. Deal with various startup time and config issues.
37 * jQuery
38 * SoundManager 2 (for flash + html5 playback)
39
40
0af32347 »
2008-03-11 alter readme to be more likely to be read
41 ### Current feature set
42
43 * Unlimited mp3 uploads for musicians
44 * Creation of playlists / albums
3241c646 »
2012-09-06 Boots in rails 3. Deal with various startup time and config issues.
45 * MP3 streaming and download (powered by amazon s3)
629c613f »
2009-06-20 README update
46 * Artist browsing
3241c646 »
2012-09-06 Boots in rails 3. Deal with various startup time and config issues.
47 * Track browsing by popularity, who you are following, most favorited, etc.
629c613f »
2009-06-20 README update
48 * Tracking of listens and providing useful feedback and statistics to artists
8f28f710 »
2013-09-22 Readme update
49 * One-way commenting system (No inline relpies. No threaded comments. No "pms")
6666235f »
2008-05-30 update readme
50 * Feeds for iTunes podcasts and offsite flash players
0af32347 »
2008-03-11 alter readme to be more likely to be read
51
601f273d »
2012-09-08 Readme update
52 ## Features wanted
0af32347 »
2008-03-11 alter readme to be more likely to be read
53
601f273d »
2012-09-08 Readme update
54 ### Browse All Playlists
d7a3a3c1 »
2012-09-07 Upgrade all scopes to rails 3 scopes/methods.
55 Low hanging fruit, boys and girls! Shoulda been a 2008 feature :)
56
601f273d »
2012-09-08 Readme update
57 ### On the fly zip downloads of playlists via nginx mod\_zip
d7a3a3c1 »
2012-09-07 Upgrade all scopes to rails 3 scopes/methods.
58 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.
59
601f273d »
2012-09-08 Readme update
60 ### Better discovery though tags
61 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:
62 1) If it's a free for all, won't it just be like genres, but messy?
63 2) Should the tags be moderated and exclude genres?
64 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?
65 4) Should there be a maximum enforced for UI purposes?
66
67 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.
68
69 ### Better overall alonetone stats page.
d7a3a3c1 »
2012-09-07 Upgrade all scopes to rails 3 scopes/methods.
70 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.
71
601f273d »
2012-09-08 Readme update
72 ### User stats page
d7a3a3c1 »
2012-09-07 Upgrade all scopes to rails 3 scopes/methods.
73 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.
74
601f273d »
2012-09-08 Readme update
75 ### A way to manage blacklisted IPs in the backend.
d7a3a3c1 »
2012-09-07 Upgrade all scopes to rails 3 scopes/methods.
76 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.
77
601f273d »
2012-09-08 Readme update
78 ### Groups.
d7a3a3c1 »
2012-09-07 Upgrade all scopes to rails 3 scopes/methods.
79 Talk with Sudara about this. There's a partial half-hearted implementation.
80
eedc6c10 »
2012-09-08 Readme: "This is not the script you are looking for"
81
8f28f710 »
2013-09-22 Readme update
82 ### Remove alonetone branding from the code
83 It would be nice to separate the alonetone branding, email address, url, and so on — out into config files.
84
85 ## Want to deploy alonetone on your server?
eedc6c10 »
2012-09-08 Readme: "This is not the script you are looking for"
86
b1b8b09b »
2013-09-17 update readme, rails4
87 ![Sorry script kiddies](https://img.skitch.com/20120908-1exaxnmix5mb82xaq32tjnrja.png)
88
8f28f710 »
2013-09-22 Readme update
89 It's not going to happen unless:
eedc6c10 »
2012-09-08 Readme: "This is not the script you are looking for"
90
8f28f710 »
2013-09-22 Readme update
91 * You know ruby on rails well (Been doing it for more than a few months).
eedc6c10 »
2012-09-08 Readme: "This is not the script you are looking for"
92 * You have deployed rails applications, and are comfortable with that.
93 * You are willing to spend 20+ hours removing our branding and logo and site-specific things from the code.
94
74e38b02 »
2012-09-08 typos
95 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.
eedc6c10 »
2012-09-08 Readme: "This is not the script you are looking for"
96
74e38b02 »
2012-09-08 typos
97 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.
eedc6c10 »
2012-09-08 Readme: "This is not the script you are looking for"
98
99 **If you still decide to try keep in mind we are unable to provide ANY support**
100
101 ## Want to help make alonetone.com awesome?
102
103 Sweet, now we are talkin'!
0af32347 »
2008-03-11 alter readme to be more likely to be read
104
63e10e7c »
2011-09-13 update ye olde readme
105 First, [sign up for an account](http://alonetone.com) and start digging in.
0af32347 »
2008-03-11 alter readme to be more likely to be read
106
63e10e7c »
2011-09-13 update ye olde readme
107 Second, hop into our Campfire chat room or email us at support@alonetone.com
6666235f »
2008-05-30 update readme
108
be222021 »
2008-10-13 readme update
109 Thirdly, fork away on github.
6666235f »
2008-05-30 update readme
110
ed650971 »
2012-10-08 Get rid of tests/*, get config copying working, travis config
111 ### Setup alonetone on localhost
be222021 »
2008-10-13 readme update
112
403fa86d »
2012-10-24 readme
113
87d05d85 »
2013-03-27 update readme for 'rake setup'
114 1) clone
403fa86d »
2012-10-24 readme
115
87d05d85 »
2013-03-27 update readme for 'rake setup'
116 2) bundle
403fa86d »
2012-10-24 readme
117
87d05d85 »
2013-03-27 update readme for 'rake setup'
118 3) Create needed config, database, and load db/seeds:
be222021 »
2008-10-13 readme update
119
87d05d85 »
2013-03-27 update readme for 'rake setup'
120 rake setup
121
122 4) rails s
0af32347 »
2008-03-11 alter readme to be more likely to be read
123
124
87d05d85 »
2013-03-27 update readme for 'rake setup'
125 Note: alonetone uses 3 config files that are created by 'rake setup'
ed650971 »
2012-10-08 Get rid of tests/*, get config copying working, travis config
126
0af32347 »
2008-03-11 alter readme to be more likely to be read
127
51562fae » kfox
2010-10-28 gave the readme some TLC
128 alonetone.yml (contains the application "secret" and app-specific settings)
129 database.yml
130 newrelic.yml (for performance tracking)
697bd19f » tiendung
2008-10-13 easier alonetone local setup
131
cbbe7609 » tiendung
2008-10-13 better guideline
132
51562fae » kfox
2010-10-28 gave the readme some TLC
133 #### Logging in
cbbe7609 » tiendung
2008-10-13 better guideline
134
8f28f710 »
2013-09-22 Readme update
135 After the bootstrap data is loaded, you can login using the test account. Username is "admin" and password is "testing123"
be222021 »
2008-10-13 readme update
136
51562fae » kfox
2010-10-28 gave the readme some TLC
137 After login, click on the "Upload" button to upload your first mp3.
6b288f42 »
2008-07-27 license stuff
138
1c34cf0c »
2012-09-08 README formatting (desperate for those commits, ya see)
139 ## License
6b288f42 »
2008-07-27 license stuff
140
141 The alonetone source code is released under the MIT license.
142
8f28f710 »
2013-09-22 Readme update
143 "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.