Coder Social home page Coder Social logo

Hacker News Kansai

This is the source code for the hnkansai.org website. It's a static site generated by Middleman and hosted on GitHub Pages.

Contributing

If you want to contribute to the project, here's a guide to help you get started.

  1. Install and read up on Middleman. If you are familiar with Ruby/Rails then you'll be up and running in no time. Most of the actual code is just HTML/JavaScript so there's no need for any deep Ruby knowledge.

  2. Fork the repo and clone it locally. There are two branches, Source and Master. You'll want to do all of your work on the Source branch (or a new topic branch you create locally).

  3. After you've cloned the repo locally, switch to the root of the project and run

$ middleman build  
$ middleman

Now you should be able to view the site locally at http://localhost:4567. Going forward, you will want to make all of your changes in the /source directory. Go wild in there. Important note: If you make changes directly in the /build directory they will be overwritten when the site is built. /source is your friend. /build is bad.

  1. When you are happy with your changes, commit and push to GitHub.
$ git checkout source
$ git add -A
$ git commit -m "Some awesome changes to HN Kansai"
$ git push origin source

Now submit your pull request to the Source branch of this repo. Once it's been accepted, we'll rebuild the site manually to incorporate your changes. If you have any questions along the way, you can contact [email protected]

Frameworks, APIs, and other cool things we used

Middleman

JQuery

Twitter Bootstrap

Meetup API

Flickr API

YouTube API

Fancybox

Squaresend

Deploying

Run middleman deploy.

HN Kansai's Projects

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.