Vulcan/README.md
Mikay Gao 4b7e5e9293 Update README.md
I think these two more steps should be clear for newcomers. Please correct me it I am wrong, I am rather new to Meteor.
2012-11-28 15:04:18 +08:00

1.3 KiB

Telescope is an open-source, real-time social news site built with Meteor

Note: Telescope is beta software. Most of it should work but it's still a little unpolished and you'll probably find some bugs. Use at your own risk :)

Learn More

Features

  • Real-time (of course!)
  • Password-based and/or Twitter auth
  • Notifications
  • Mobile-ready & responsive
  • Invite-only access for reading and/or posting
  • Markdown support
  • Day by day view

Installation

  • Install Meteor
  • Install Meteorite
  • Download or clone Telescope into /some/path
  • cd /some/path
  • Run mrt

Running Telescope on Heroku

  • Use the Heroku buildpack for Meteorite to push to Heroku: heroku create --stack cedar --buildpack https://github.com/oortcloud/heroku-buildpack-meteorite.git
  • Add MongoHQ addon

First Run

  • Set the root URL variable used for Twitter auth (on Heroku: heroku config:add ROOT_URL=http://your_url)
  • Fill in your Twitter keys
  • The first user account created will automatically be made admin
  • Check out the settings page and fill out basic things like the site's name