Giter VIP home page Giter VIP logo
KanRule photo

kanrule Goto Github PK

repos: 54.0 gists: 0.0

Name: KanRule

Type: Organization

Bio: Open Source Kanban prototypes (mostly not working), archived not-in-use code, mostly with MIT license. And contributing to any Kanban software.

Location: Finland

Blog: https://kanrule.org

A simplified Jira clone built with React and Node

Auto formatted with Prettier, tested with Cypress ๐ŸŽ—

Tech logos

App screenshot

What is this and who is it for ๐Ÿคทโ€โ™€๏ธ

From current maintainer of KanRule

xet7 is also current maintainer of Wekan. This KanRule is a fork of another MIT licensed Open Source Kanban board, just to see can it be made usable enough. You can send pull requests to this project. There is no CLA required for contributing.

From original creator oldboyxx:

I do React consulting and this is a showcase product I've built in my spare time. It's a very good example of modern, real-world React codebase.

There are many showcase/example React projects out there but most of them are way too simple. I like to think that this codebase contains enough complexity to offer valuable insights to React developers of all skill levels while still being relatively easy to understand.

Features

  • Proven, scalable, and easy to understand project structure
  • Written in modern React, only functional components with hooks
  • A variety of custom light-weight UI components such as datepicker, modal, various form elements etc
  • Simple local React state management, without redux, mobx, or similar
  • Custom webpack setup, without create-react-app or similar
  • Client written in Babel powered JavaScript
  • API written in TypeScript and using TypeORM

Setting up development environment ๐Ÿ› 

  • Install postgreSQL if you don't have it already and create a database named kanrule_development.
  • git clone https://github.com/KanRule/KanRule.git
  • Create an empty .env file in /api, copy /api/.env.example contents into it, and fill in your database username and password.
  • npm run install-dependencies
  • cd api && npm start
  • cd client && npm start in another terminal tab
  • App should now be running on http://localhost:8080/

Running cypress end-to-end tests ๐Ÿšฅ

  • Set up development environment
  • Create a database named kanrule_test and start the api with cd api && npm run start:test
  • cd client && npm run test:cypress

What's missing?

There are features missing from this showcase product which should exist in a real product:

Migrations ๐Ÿ—„

We're currently using TypeORM's synchronize feature which auto creates the database schema on every application launch. It's fine to do this in a showcase product or during early development while the product is not used by anyone, but before going live with a real product, we should introduce migrations.

Proper authentication system ๐Ÿ”

We currently auto create an auth token and seed a project with issues and users for anyone who visits the API without valid credentials. In a real product we'd want to implement a proper email and password authentication system.

Accessibility โ™ฟ

Not all components have properly defined aria attributes, visual focus indicators etc. Most early stage companies tend to ignore this aspect of their product but in many cases they shouldn't, especially once their userbase starts growing.

Unit/Integration tests ๐Ÿงช

Both Client and API are currently tested through end-to-end Cypress tests. That's good enough for a relatively simple application such as this, even if it was a real product. However, as the app grows in complexity, it might be wise to start writing additional unit/integration tests.

Current Maintainer: KanRule Team

Related forks

  1. Original Author: Ivor Reic โœ๏ธ
  1. https://github.com/FauxJira/FauxJira

License

MIT


KanRule's Projects

bookstack icon bookstack

A platform to create documentation/wiki content built with PHP & Laravel

boxd_api icon boxd_api

Forked from https://github.com/oldboyxx/boxd_api

dsq icon dsq

Commandline tool for running SQL queries against JSON, CSV, Excel, Parquet, and more.

esbuild icon esbuild

An extremely fast JavaScript bundler and minifier

idaesbasic icon idaesbasic

Idaesbasic - An all in one project manager that stores everything in files directly into your project! ๐Ÿคฏ

jira-cli icon jira-cli

๐Ÿ”ฅ [WIP] Feature-rich interactive Jira command line.

kanban icon kanban

A real-time & persistent kanban board.

kanrule icon kanrule

Open Source Kanban with MIT licence

leantime icon leantime

Leantime is a lean project management system for innovators. Designed to help you manage your projects from ideation to delivery.

localstack icon localstack

๐Ÿ’ป A fully functional local AWS cloud stack. Develop and test your cloud & Serverless apps offline!

markdown icon markdown

GitHub flavored markdown parser for Meteor based on marked.js

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.