huncwot/README.md

A Programming Environment for TypeScript apps built on top of VS Code

<p align="center">
  <img width="250" src="/docs/huncwot-logo.svg">
</p>

<h1 align="center">
  <a href="https://kretes.dev">Kretes</a>
  <small>(formerly Huncwot)</small>
</h1>

<p align="center">
  <b>A programming environment for TypeScript applications <br />
  built on top of <a href="https://code.visualstudio.com/">Visual Studio Code</a>. <br/> 
  It combines a web framework with an editor <br /> 
  into an integrated, battery-included solution.</b>
</p>

<br>

<p align="center">
  <a href="https://landing.mailerlite.com/webforms/landing/a3k0m1"><img src="https://img.shields.io/badge/%20newsletter%20-%20subscribe%20-blue.svg?style=for-the-badge" alt="Subscribe to Kretes Newsletter"></a>
  <a href="https://www.npmjs.com/package/huncwot"><img src="https://img.shields.io/npm/v/huncwot.svg?style=for-the-badge" alt="Kretes Package on NPM"></a>
  <a href="https://www.npmjs.com/package/huncwot"><img src="https://img.shields.io/npm/dm/huncwot.svg?style=for-the-badge" alt="Kretes Package on NPM"></a>
  <a href="https://discord.gg/befPaNb"><img src="https://img.shields.io/badge/Discord-join%20chat-738bd7.svg?style=for-the-badge" alt="Kretes channel on Discord"></a>
  <a href="https://www.youtube.com/playlist?list=PLhXZp00uXBk72m_G7E2Bshzd7PDpaInE1"><img src="https://img.shields.io/badge/YouTube-Watch%20Screencasts-red?style=for-the-badge" alt="Kretes related screencasts on YouTube"></a>
</a>

Kretes is a **programming environment** for building modern web applications
using TypeScript & Node.js with « batteries included » approach. It is an **integrated** solution that optimizes for programmers productivity by reducing choices and incorporating community conventions.


[Website](https://kretes.dev) |
[Twitter](http://twitter.com/kreteshq)

## Table of Contents

* [Rationale](#rationale)
* [Features In A Nutshell](#features-in-a-nutshell)

## Rationale

Kretes is being built with *battery included* approach in mind, i.e. it comes
with a (eventually large) library of useful modules which are developed in a
coherent way. This stands in direct opposition to Koa approach. Kretes tries to formalize conventions and eliminate valueless choices by providing solid defaults for building web applications that increase the programmers productivity.

Kretes fights against [the accidental complexity](https://wiki.c2.com/?AccidentalComplexity). Let's focus on business needs of our applications instead of constantly configuring, patching and putting together various software elements.

## Features In A Nutshell

Kretes bridges client-side (*frontend*) and server-side (*backend*) development
by using [a single programming language - JavaScript - across the
board](https://cdb.reacttraining.com/universal-javascript-4761051b7ae9).

The project draws inspiration from Rails while trying to be less *magical*, if
any at all. In Kretes, you write your applications using
[TypeScript](https://www.typescriptlang.org/). 

As a secondary goal, Kretes tries to minimize the dependencies. It uses
external packages only if absolutely necessary (e.g. security, OS abstractions
etc).

## Roadmap

Kretes keeps track of the upcoming fixes and features on GitHub Projects:
[Kretes Roadmap](https://github.com/kreteshq/huncwot/projects/1)

## Bug reports

We use *Github Issues* for managing bug reports and feature requests. If you run
into problems, please search the *issues* or submit a new one here:
https://github.com/kreteshq/kretes/issues

Detailed bug reports are always great; it's event better if you are able to
include test cases.