Code Monkey home page Code Monkey logo

kanban_board's Introduction

Kanban Board

Idea

This project consists of a very rudimentary version of a Kanban/Trello board, currently usable by a single user (which I know for the most part, is not very useful). The app allows a user to create an account, log in, create projects, add tasks to said projects, and progress the tasks through 3 states of completion: "TO DO", "In-Progress" and "Completed". The app offers a very minimal/barebones/ugly user interface (chose a descriptor based on however polite or accurate you like to be, I did not view this as a front end project.)

This is a project built to display my understanding of several concepts.

  1. ActiveRecord & Sinatra.
  2. MVC program architecture.
  3. CRUD functionality.
  4. Using multiple models.
  5. Modelling user accounts.
  6. User authentication.
  7. Input validation.

Installation

  1. clone this repository.

     git clone https://github.com/SVRourke/kanban_board.git
    
  2. cd into the project directory and run "bundle install

  3. At this point you can either start the program with shotgun or rackup.

  4. BONUS if you'd like greater security you need to comment out the line in the application controller with the hardcoded session secret and set a random secret as an environment variable.

     app/controllers/application_controller
     # Comment this line out:
     set :session_secret, 'Development'  
     # Uncomment this line
     set :session_secret, ENV.fetch('SESSION_SECRET')
    
  5. Then create an environment variable 'SESSION_SECRET' and set it to a random 64 byte hex.

     # Generate a key
     ruby -e "require 'securerandom'; puts SecureRandom.hex(64)"  
     
     # copy the output to the clipboard
     $> 6cbb8fa...(shortened for brevity)...55fb724
    
     # create the environment variable
     echo "export SESSION_SECRET=COPIED-VALUE" >> ~/.bashrc
    

Contributors Guide

Contribution is welcome, fork the repo, create a branch, go ham.
if you think your changes would be a good addition to the project, drop me a line. If you'd like to use this as a starting point for your own project? GO Ahead! I do not intend to turn this into a product or business, this was purely an educational exercise.

license

MIT License

Copyright (c) 2020 Samuel V. Rourke

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

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.