[gem]: https://rubygems.org/gems/pakyow
[travis]: https://travis-ci.org/pakyow/pakyow
[gemnasium]: https://gemnasium.com/pakyow/pakyow
[inchpages]: http://inch-ci.org/github/pakyow/pakyow
[codeclimate]: https://codeclimate.com/github/pakyow/pakyow

# Pakyow Web Framework [![Gitter chat](https://badges.gitter.im/pakyow/chat.svg)](https://gitter.im/pakyow/chat)

Pakyow lets you build modern apps that don't break the web.

It provides features such as auto-updating views while embracing traditional
concepts like progressive enhancement. Designed to be as simple as possible, it
helps you quickly create momentum and maintain it throughout a project.

**Embraces the new web (without breaking it).**  
Views automatically stay in sync with the server, with no extra code. Pakyow
brings progressive enhancement to the modern web.

**Removes friction from development.**  
Quickly build a prototype with only HTML and CSS. Later on, build right on top
of the prototype without throwing out previous work.

**Accessible to everyone.**  
Pakyow makes it a little bit easier to get started. We believe that a simpler
web empowers more contribution, leading towards a more democratic web.

---

[![Gem Version](https://badge.fury.io/rb/pakyow.svg)][gem]
[![Build Status](https://travis-ci.org/pakyow/pakyow.svg?branch=master)][travis]
[![Dependency Status](https://gemnasium.com/pakyow/pakyow.svg)][gemnasium]
[![Inline docs](http://inch-ci.org/github/pakyow/pakyow.svg?branch=master&style=flat)][inchpages]

---

# Getting Started

1. Install Pakyow:

    `gem install pakyow`

2. Create a new Pakyow project from the command line:

    `pakyow new webapp`

3. Move to the new directory and start the server:

    `cd webapp; bundle exec pakyow server`

4. You'll find your project running at [http://localhost:3000](http://localhost:3000)!

# Next Steps

- Read the [overview](https://pakyow.org/docs/overview) to better understand the goals and architecture of Pakyow.
- Go through the [warmup](https://pakyow.org/docs/warmup) to build & deploy your first project.
- Browse the [docs](https://pakyow.org/docs) to learn more about presentation, routing, realtime channels, and more.
- Check out the [code](https://github.com/pakyow/pakyow) on GitHub.

We'd love to have you involved. Here are a few places to start:

- [Give us a star](https://github.com/pakyow/pakyow)
- [Participate in chat](https://gitter.im/pakyow/chat)
- [Join the forums](http://forums.pakyow.org/)
- [Work on a starter issue](https://github.com/pakyow/pakyow/labels/Starter)
- [Report problems](https://github.com/pakyow/pakyow/issues)
- [Tell your friends](https://twitter.com/share?text=Pakyow,%20build%20modern%20apps%20that%20don%27t%20break%20the%20web&hashtags=pakyow&url=https://pakyow.org)

# License

Pakyow is released free and open-source under the [MIT License](http://opensource.org/licenses/MIT).