Giter Club home page Giter Club logo

rekit's Introduction

๐ŸŽ‰๐ŸŽ‰๐ŸŽ‰ Introducing Rekit Studio: a real IDE for React and Redux development

Rekit is a toolkit for building scalable web applications with React, Redux and React-router. It's an all-in-one solution for creating modern React apps.

It helps you focus on business logic rather than dealing with massive libraries, patterns, configurations etc.

Version Build Status Dependency Status Coverage Status Gitter Demo MIT licensed

Rekit creates apps using an opinionated folder and code structure. It's designed to be scalable, testable and maintainable by using feature oriented architecture, one action per file pattern. This ensures application logic is well grouped and decoupled.

Besides creating apps, Rekit provides powerful tools for managing the project:

  1. Rekit Studio: the real IDE for React, Redux development.
  2. Command line tools: besides Rekit Studio, you can use command line tools to create/rename/move/delete project elements like components, actions etc. It has better support for Rekit plugin system.

Below is a quick demo video of how Rekit works:

Rekit Demo

The demo contains two parts, which are examples in Redux's official website:

  1. Create a simple counter in 1 minute!
  2. Show the latest reactjs topics on Reddit using async actions.

Live Demo

You can also see the live demo at: http://demo.rekit.org

Installation

npm install -g rekit

This will install a global command rekit to the system. Rekit is developed and tested on npm 3+ and node 6+, so this is the prerequisite for using Rekit.

Usage

Create a new application

rekit create <app-name> [--sass] [--clean]

This will create a new app named app-name in the current directory. The --sass flag allows to use sass instead of default less as the CSS transpiler. The --clean flag is used to create a clean app without any sample code. After creating the app, you need to install dependencies and start the dev server:

cd app-name
npm install
npm start

It then starts three lightweight express servers by default:

  1. Wepback dev server: http://localhost:6075. This is the dev server your application is running on.
  2. Rekit Studio: http://localhost:6076. The IDE for Rekit projects.
  3. Build result test server: http://localhost:6077. This is the server for verifying the build result before deploying to production server.

To change the ports dev-servers running on, edit the rekit section in package.json:

{
  ...
  "rekit": {
    "devPort": 6075,
    "studioPort": 6076,
    "buildPort": 6077,
    ...
  }
  ...
}

Packages

This repo contains multiple packages managed by yarn workspaces.

Packages Description
rekit-core Provide core APIs such as create components, rename actions, etc...
rekit The CLI wrapper of rekit-core, and create apps by clone repo from rekit-boilerplate
rekit-studio Dedicated IDE for Rekit development, uses rekit-core to manage project too.
rekit-plugin-redux-saga Use redux-saga instead of redux-thunk for async actions.
rekit-plugin-selector Support selectors by Rekit cli.

Key Features

  • It's production-ready but not a starter kit.
  • Zero additional configuration needed after creating an app.
  • Dedicated IDE for Rekit development.
  • Command line tools to manage actions, reducers, components and pages.
  • Embed build script and test server for the build result.
  • Use Webpack 3 for bundling.
  • Use Babel for ES2015(ES6)+ support.
  • Use React hot loader for hot module replacement.
  • Use Redux for application state management.
  • Use React-router for routing and it's configured with Redux reducer.
  • Use Webpack dll plugin to improve dev-time build performance.
  • Use Less or Sass as CSS transpilers.
  • Use mocha, enzyme for testing.
  • Use istanbul for testing coverage report.
  • Support Redux dev tools.
  • Proxy to API in DEV like create-react-app. e.g. fetch(/api/<your path>)

Documentation

http://rekit.js.org

License

MIT

rekit's People

Contributors

supnate avatar nelreina avatar radarhere avatar jhsu avatar moklick avatar sseletskyy avatar chesshacker avatar vherrin avatar meeoh avatar mike706574 avatar

Watchers

 avatar

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.