Note: this project is currently on hold due to other commitments

Catkin

An open source agile tool, aiming to be a viable alternative to Jira and Trello (still with a lot of development to do!).

View Demo · Report Bug · Request Feature

Table of Contents

• Table of Contents
• About The Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

About The Project

Our aim is to make a fast, easy to use agile workflow too focused on ensuring high quality user stories.

• Persona tagging -the novelty of 'As a xxxxx I want to' has warn off
• User story quality checks - liting to make sure user stories are written in the expected format (coming soon!)
• User story rating system - devs can vote on the most useful stories (coming soon!)

Built With

• nest.js
• vue.js
• vuetify

Getting Started

To get a local copy or your own server up and running follow these steps.

Prerequisites

• Install Yarn from https://yarnpkg.com
• Create an Auth0 account and application, you'll use the KPI key in Catkin configuration

Installation

1. Clone the repo

git clone https://github.com/MeStrak/catkin.git

2. Install packages In both frontend and backend folders:

yarn

3. Setup frontend .env file Copy template.env and rename as .env (you can use .env.development, .env.production according to vue.js .env naming conventions)

For a local development environment assuming you use default nest.js ports.

VUE_APP_GRAPHQL_HTTP = 'http://localhost:3000/graphql'
VUE_APP_GRAPHQL_WS= 'ws://localhost:3000/graphql'
VUE_APP_AUTH0_CLIENT_ID = from Auth0
VUE_APP_AUTH0_DOMAIN = from Auth0 config
VUE_APP_AUTH0_REDIRECT = http://localhost:8080/callback (to be added to Auth0 app allowed callback URLs)
VUE_APP_AUTH0_SCOPE = full_access
VUE_APP_AUTH0_AUDIENCE = from Auth0 config (your domain name)

For deployed environments, localhost addresses should be updated to the server or domain name.

4. Setup backend .env file

AUTH0_DOMAIN=from Auth0 config
AUTH0_AUDIENCE=https://catkin.dev
MONGO_CONNECTION=configure for your mongodb server, template format provided in template.env file

Usage

Catkin can be used by agile dev teams and other types of project. With a bit more work and some kind contributors hopefully it can challenge Trello for usability and beat Jira for useful functionality.

Roadmap

Check implementation progress directly in the demo website where the backlog is prioritised.

Major features that we plan to implement once the basic app is stable:

• User story linting
• User story rating
• Specifications
• Organisations
• Board permissions

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Project Link: https://github.com/MeStrak/catkin

Acknowledgements

• vue-kanban
• Kamil Mysliwec (nest.js creator)
• Gabriel Tanner's article used to get a headstart on nest.js backend dev