Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 125 lines (76 sloc) 5.018 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
6b4628b @sudara another test github commit
authored
5 alonetone was launched in January 2008
0af3234 @sudara alter readme to be more likely to be read
authored
6
6666235 @sudara update readme
authored
7 ## alonetone is looking for more love
8
9 Are you a musician / music lover with Rails or UI/design chops?
10
11 Help us to build the best indy music platform out there.
12
13 If you are interested, [sign up over at alonetone](http://alonetone.com/signup) and check out what is there. We could always use more usability/UI/design help, basic testing, general feedback, and eventually, some more Rails love.
14
15 Secondly, please email me at sudara at alonetone dot com.
0af3234 @sudara alter readme to be more likely to be read
authored
16
e14bf2f @sudara
authored
17 ### Bug reporting
18
19 We use [lighthouse](http://alonetone.lighthouseapp.com) to submit bugs and keep track of our work
20
0af3234 @sudara alter readme to be more likely to be read
authored
21 ### The goal?
22
d383580 @sudara It would be 'boring' to complain about IE7, especially compared with …
authored
23 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 umbrella of a corporation.
0af3234 @sudara alter readme to be more likely to be read
authored
24
6666235 @sudara update readme
authored
25 How do we reach this goal?
0af3234 @sudara alter readme to be more likely to be read
authored
26
d383580 @sudara It would be 'boring' to complain about IE7, especially compared with …
authored
27 * It is easy to use, intuitive, and consistent (grandma-friendly)
28 * It is attractive to look at
0af3234 @sudara alter readme to be more likely to be read
authored
29 * It provides musicians with practical, useful and inspiring tools and services
6666235 @sudara update readme
authored
30 * 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.
d383580 @sudara It would be 'boring' to complain about IE7, especially compared with …
authored
31 * It encourages artist exploration
773c3c2 @sudara Add a few more pointers for open sourcing
authored
32 * 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
33
34 For more info, visit [the alonetone faq](http://alonetone.com/about)
35
36
37 ### Current feature set
38
39 Really, only the very basics are implemented.
40
41 * Unlimited mp3 uploads for musicians
42 * Creation of playlists / albums
43 * MP3 streaming and download
44 * Basic artist browsing
45 * Tracking of listens and providing useful feedback to artists
46 * Very basic commenting system
6666235 @sudara update readme
authored
47 * Facebook integration
48 * Feeds for iTunes podcasts and offsite flash players
0af3234 @sudara alter readme to be more likely to be read
authored
49
50 ### Current tech
51
a32c201 @sudara modify readme (testing)
authored
52 * Rails 2.1
0af3234 @sudara alter readme to be more likely to be read
authored
53 * Rspec
6666235 @sudara update readme
authored
54 * jQuery and LowPro
0af3234 @sudara alter readme to be more likely to be read
authored
55 * SoundManager 2 (for flash mp3 playback)
773c3c2 @sudara Add a few more pointers for open sourcing
authored
56 * SASS (the cool stylesheet thing from the haml folks)
0af3234 @sudara alter readme to be more likely to be read
authored
57
58 ### Want to join forces?
59
be22202 @sudara readme update
authored
60 First of all, talk to Sudara by emailing Sudara at alonetone com
0af3234 @sudara alter readme to be more likely to be read
authored
61
6666235 @sudara update readme
authored
62 Secondly, [sign up for an account](http://alonetone.com) and start digging in.
63
be22202 @sudara readme update
authored
64 Thirdly, fork away on github.
6666235 @sudara update readme
authored
65
be22202 @sudara readme update
authored
66 ### Playing with alonetone on localhost
67
e006a30 @sudara more text updates
authored
68 This is *not* a task for Rails newbees.
be22202 @sudara readme update
authored
69
70 I've had multiple requests asking me to walk folks through setting up alonetone locally. Unless you have some experience with rails, it's just not going to be worth it unless you have a lot of time to invest.
0af3234 @sudara alter readme to be more likely to be read
authored
71
6666235 @sudara update readme
authored
72 If you do want to get jiggy and setup alonetone locally, the best thing to do is to contact me first, as things are ever-changing.
0af3234 @sudara alter readme to be more likely to be read
authored
73
af89b6b @tiendung correct 5 to 6
tiendung authored
74 alonetone uses 6 config files:
0af3234 @sudara alter readme to be more likely to be read
authored
75
a3641da @sudara More readme changes
authored
76 alonetone.yml (contains the application "secret" and app-specific settings)
0af3234 @sudara alter readme to be more likely to be read
authored
77 database.yml
a3641da @sudara More readme changes
authored
78 amazon_s3.yml (used in production, by default development mode runs with :file_system storage)
79 defensio.yml (spam protection, ignored in development)
80 facebooker.yml (for facebook app, ignore this in general for now)
e14bf2f @sudara
authored
81 newrelic.yml (for performance tracking)
697bd19 @tiendung easier alonetone local setup
tiendung authored
82
a3641da @sudara More readme changes
authored
83 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
84
85 You'll need some gems, at least:
86
87 rmagick
88 haml
d383580 @sudara It would be 'boring' to complain about IE7, especially compared with …
authored
89 json
0af3234 @sudara alter readme to be more likely to be read
authored
90 ruby-mp3info
91 googlecharts
697bd19 @tiendung easier alonetone local setup
tiendung authored
92 aws-s3 (if you use Amazon S3 to store files)
773c3c2 @sudara Add a few more pointers for open sourcing
authored
93 rubyzip (for extracting mp3s from zip files)
697bd19 @tiendung easier alonetone local setup
tiendung authored
94 mocha (for rspec)
8474aee @sudara testing github
authored
95
be22202 @sudara readme update
authored
96 You can let the system install all required gems for you using following command:
e006a30 @sudara more text updates
authored
97
697bd19 @tiendung easier alonetone local setup
tiendung authored
98 rake gems:install
99
991bed8 Signed-off-by: Sudara <sudara@alonetone.com>
visaudio authored
100 NOTE: On a Windows install using InstantRails with Rails 2.2.2 and RubyGems 1.3, an error such as 'uninitialized constant ApplicationController::ALONETONE' might present itself when using the 'rake gems:install' command. However, I found that if you install all of the gems manually that you can ignore this error message.
101
be22202 @sudara readme update
authored
102 You can also install them manually:
cbbe760 @tiendung better guideline
tiendung authored
103
e006a30 @sudara more text updates
authored
104 sudo gem install rmagick haml json ruby-mp3info aws-s3 rubyzip mocha
be22202 @sudara readme update
authored
105
e006a30 @sudara more text updates
authored
106 You may need to install imagemagick before rmagick. If you are using Ubuntu you can run 'sudo apt-get install imagemagick libmagick9-dev'. If you are on a Mac, you can 'sudo port install imagemagick'
cbbe760 @tiendung better guideline
tiendung authored
107
697bd19 @tiendung easier alonetone local setup
tiendung authored
108 You'll need to install rails 2.1 gem or have a copy in the vendor directory.
773c3c2 @sudara Add a few more pointers for open sourcing
authored
109
e006a30 @sudara more text updates
authored
110 Then, you can create a development database, run all migrations and load some bootstrap data with:
be22202 @sudara readme update
authored
111
697bd19 @tiendung easier alonetone local setup
tiendung authored
112 rake db:remake
773c3c2 @sudara Add a few more pointers for open sourcing
authored
113
cbbe760 @tiendung better guideline
tiendung authored
114
697bd19 @tiendung easier alonetone local setup
tiendung authored
115 After bootstrap data is loaded, you can login using test account with username=test, password=test.
be22202 @sudara readme update
authored
116
117 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
118
e006a30 @sudara more text updates
authored
119 After login, click on "Upload" button to upload your first mp3.
6b288f4 @sudara license stuff
authored
120
121 ### License
122
123 The alonetone source code is released under the MIT license.
124
697bd19 @tiendung easier alonetone local setup
tiendung authored
125 "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.