https://github.com/hph/log

Collaborate with others by posting short messages via a comamnd-line interface to the web!
https://github.com/hph/log

Last synced: 10 days ago
JSON representation

Collaborate with others by posting short messages via a comamnd-line interface to the web!

• Host: GitHub
• URL: https://github.com/hph/log
• Owner: hph
• License: mit
• Created: 2013-10-23T21:02:45.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2013-11-09T02:18:13.000Z (almost 11 years ago)
• Last Synced: 2024-10-13T07:41:32.981Z (25 days ago)
• Language: Ruby
• Homepage:
• Size: 242 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
Log

===

Collaborate with others by posting short messages via a comamnd-line interface

to the web!

The idea is that you can write short messages for anyone (you allow) to read. A

poster might run (in the terminal):

    log "Hello, World!"

Log proceeds to post this to a server where the messages can be read from,

either through the web interface or by commands:

    log user

Which will show the messages by that user. Note that user-specific

functionality is not ready.

Installation

------------

For Log to work, you must first install PostgreSQL and Ruby 2.0.0. Then you

can simply run the following commands:

    git clone https://github.com/hph/log.git && cd log

    bundle install

    createdb log

    rake db:schema:load

Now you will have to create a directory called `config` and inside it, a file

called `database.yml`. It should look somewhat like this:

    adapter:  'postgresql'

    host:     'localhost'

    username: 'your_db_username'

    password: 'your_db_password'

    database: 'log'

Now you should be all set. Open two terminals. Run `./app.rb` in one and

`./log.rb ` in the other. Now visit

[http://localhost:4567](http://localhost:4567). You should see the message you

just posted.

To set up a remote server to handle requests you will have to go through a few

extra steps.

Installation Notes

------------------

You could use SQLite or MySQL but you will have to install the gems yourself.

The same goes for the Ruby version, if you want to use an older one, you can

change the specified version in `Gemfile`.

If you've installed the program on a server and want to post to it from your

local machine, you must set the `STATUS_SERVER` environment variable to the

address of the remote server by adding a statement to your shell configuration

file (e.g., `~/.zshrc`): `export STATUS_SERVER=http://example.com`

Roadmap

-------

The command-line interface to `log.rb` is nonexistent. Users should be able to

specify tags and permissions, delete messages and search for old messags. Users

should be able to search for messages from other users via the command-line

interface. The web interface should allow logins for restricted messages.