Shard Detail

hackerviews v0.1.0

A social platform inspired by Hacker News written in Crystal using the Kemal framework.

Install & Use

Add the following code to your project's shard.yml under:

dependencies to use in production
- OR -
development_dependencies to use in development


hackerviews:
  github: jessehorne/hackerviews

Readme

hackerviews

Medium


Hacker Views is a social platform for developers, inspired by Hacker News, designed to give more data to users about their posts.

screenshot


Note

Things will be changing quite a bit. The current version is just a rough prototype. If any sort of community forms, I will set up a Slack and potentially an Email list. For general inspiration on running a community, see Open Source Guides.


Installation

  1. Install Crystal
  2. Pull the repository
  3. Run 'shards install' in the projects root directory
  4. Create '.env' in root project directory (see .env.example)
  5. Create MySQL Database according to values in '.env'
  6. Run './src/micrate up' in root project directory to run migrations
  7. Run 'crystal run src/hackerviews.cr' in root project directory
  8. Visit 'http://localhost:3000/' in your web browser to make sure things are working!

(better instructions coming soon...)

Development

  1. Get the application running (See Installation)
  2. If you find bugs, first create an issue.
  3. If you'd like to close tickets or implement your own ideas, see Contributing

Contributing

  1. Fork it (https://github.com/jessehorne/hackerviews/fork)
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

Contributors