Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 102 lines (59 sloc) 4.069 kb
0af3234 @sudara alter readme to be more likely to be read
authored
1 ## The future is bright
2
6666235 @sudara update readme
authored
3 [alonetone](http://alonetone.com) is a growing independent music platform, providing free services for musicians wanting 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
4
63e10e7 @sudara update ye olde readme
authored
5 alonetone was launched in January 2008. As of September 2011 it hosts over 30,000 songs from 2500 musicians and has delivered over 2 million mp3s to real listeners.
0af3234 @sudara alter readme to be more likely to be read
authored
6
63e10e7 @sudara update ye olde readme
authored
7 ## Give us some dev love
6666235 @sudara update readme
authored
8
63e10e7 @sudara update ye olde readme
authored
9 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, to their listeners, and to a source of inspiration.
0af3234 @sudara alter readme to be more likely to be read
authored
10
e14bf2f @sudara
authored
11 ### Bug reporting
12
63e10e7 @sudara update ye olde readme
authored
13 We use [Github Issues](http://github.com/sudara/alonetone/issues) to submit bugs and keep track of our work.
e14bf2f @sudara
authored
14
63e10e7 @sudara update ye olde readme
authored
15 ### Our goal?
0af3234 @sudara alter readme to be more likely to be read
authored
16
63e10e7 @sudara update ye olde readme
authored
17 To create and run the best online home a musician could want to have, providing them with the tools they need to reach their listeners and network with other artists, without the stank of commercialism or startup flava. Yup, we're half hippie communists.
0af3234 @sudara alter readme to be more likely to be read
authored
18
6666235 @sudara update readme
authored
19 How do we reach this goal?
0af3234 @sudara alter readme to be more likely to be read
authored
20
629c613 @sudara README update
authored
21 * It must be easy to use, straightforward, intuitive, and consistent (grandma-friendly)
22 * It must be attractive to look at
0af3234 @sudara alter readme to be more likely to be read
authored
23 * It provides musicians with practical, useful and inspiring tools and services
51562fa @kfox gave the readme some TLC
kfox authored
24 * It provides listeners and first time site visitors with a 'hook' into their first taste of alonetone music and helps them explore the site in an intelligent and guided way
25 * It encourages artist exploration and the feeling to stick around
773c3c2 @sudara Add a few more pointers for open sourcing
authored
26 * 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
27
28 For more info, visit [the alonetone faq](http://alonetone.com/about)
29
30 ### Current feature set
31
32 * Unlimited mp3 uploads for musicians
33 * Creation of playlists / albums
63e10e7 @sudara update ye olde readme
authored
34 * MP3 streaming and download (powered by s3)
629c613 @sudara README update
authored
35 * Artist browsing
36 * Tracking of listens and providing useful feedback and statistics to artists
37 * Commenting system
6666235 @sudara update readme
authored
38 * Feeds for iTunes podcasts and offsite flash players
0af3234 @sudara alter readme to be more likely to be read
authored
39
40 ### Current tech
41
63e10e7 @sudara update ye olde readme
authored
42 * Rails 2.3.11
6666235 @sudara update readme
authored
43 * jQuery and LowPro
0af3234 @sudara alter readme to be more likely to be read
authored
44 * SoundManager 2 (for flash mp3 playback)
63e10e7 @sudara update ye olde readme
authored
45 * SASS
0af3234 @sudara alter readme to be more likely to be read
authored
46
63e10e7 @sudara update ye olde readme
authored
47 ### Want to help us?
0af3234 @sudara alter readme to be more likely to be read
authored
48
63e10e7 @sudara update ye olde readme
authored
49 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
50
63e10e7 @sudara update ye olde readme
authored
51 Second, hop into our Campfire chat room or email us at support@alonetone.com
6666235 @sudara update readme
authored
52
be22202 @sudara readme update
authored
53 Thirdly, fork away on github.
6666235 @sudara update readme
authored
54
63e10e7 @sudara update ye olde readme
authored
55 ### Setting up alonetone on localhost
be22202 @sudara readme update
authored
56
63e10e7 @sudara update ye olde readme
authored
57 This is *not* a task for Rails newbees. This is not a 'clone script' that is easy to setup on your servers. We cannot provide ANY support so please do not email us requesting this.
be22202 @sudara readme update
authored
58
63e10e7 @sudara update ye olde readme
authored
59 Unless you have LOTS of experience with rails, you should not consider trying to set this up.
0af3234 @sudara alter readme to be more likely to be read
authored
60
63e10e7 @sudara update ye olde readme
authored
61 If you live and breathe rails and you want to get jiggy:
0af3234 @sudara alter readme to be more likely to be read
authored
62
af89b6b @tiendung correct 5 to 6
tiendung authored
63 alonetone uses 6 config files:
0af3234 @sudara alter readme to be more likely to be read
authored
64
51562fa @kfox gave the readme some TLC
kfox authored
65 alonetone.yml (contains the application "secret" and app-specific settings)
66 database.yml
67 amazon_s3.yml (used in production, by default development mode runs with :file_system storage)
68 defensio.yml (spam protection, ignored in development)
69 facebooker.yml (for facebook app, ignore this in general for now)
70 newrelic.yml (for performance tracking)
697bd19 @tiendung easier alonetone local setup
tiendung authored
71
a3641da @sudara More readme changes
authored
72 These files will be created for you the first time you run any rake task.
0af3234 @sudara alter readme to be more likely to be read
authored
73
51562fa @kfox gave the readme some TLC
kfox authored
74 #### Gem installation
75
e006a30 @sudara more text updates
authored
76
63e10e7 @sudara update ye olde readme
authored
77 We use bundler. You'll need imagemagick installed. If you have the Bundler gem installed, you can install all of the dependencies like so:
697bd19 @tiendung easier alonetone local setup
tiendung authored
78
63e10e7 @sudara update ye olde readme
authored
79 `bundle install`
991bed8 Signed-off-by: Sudara <sudara@alonetone.com>
visaudio authored
80
cbbe760 @tiendung better guideline
tiendung authored
81
be22202 @sudara readme update
authored
82
51562fa @kfox gave the readme some TLC
kfox authored
83 #### Database setup
773c3c2 @sudara Add a few more pointers for open sourcing
authored
84
e006a30 @sudara more text updates
authored
85 Then, you can create a development database, run all migrations and load some bootstrap data with:
be22202 @sudara readme update
authored
86
697bd19 @tiendung easier alonetone local setup
tiendung authored
87 rake db:remake
773c3c2 @sudara Add a few more pointers for open sourcing
authored
88
51562fa @kfox gave the readme some TLC
kfox authored
89 #### Logging in
cbbe760 @tiendung better guideline
tiendung authored
90
51562fa @kfox gave the readme some TLC
kfox authored
91 After the bootstrap data is loaded, you can login using the test account (username=test, password=test).
be22202 @sudara readme update
authored
92
51562fa @kfox gave the readme some TLC
kfox authored
93 You will see session and current\_user information at the end of each page after login. You can turn it off by changing show\_debug_info to false in alonetone.yml.
cbbe760 @tiendung better guideline
tiendung authored
94
51562fa @kfox gave the readme some TLC
kfox authored
95 After login, click on the "Upload" button to upload your first mp3.
6b288f4 @sudara license stuff
authored
96
97 ### License
98
99 The alonetone source code is released under the MIT license.
100
51562fa @kfox gave the readme some TLC
kfox authored
101 "alonetone", "alonetone.com" and the alonetone logo are copyright Sudara Williams 2008 and may not be used without permission.
Something went wrong with that request. Please try again.