Skip to content

Latest commit

 

History

History
206 lines (148 loc) · 6.17 KB

README.md

File metadata and controls

206 lines (148 loc) · 6.17 KB
Raw

NinjaBoard


NinjaBoard

A Gamified Learning Management System and Dashboard
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

Product Name Screen Shot

NinjaBoard is a gamified learning management system and dashboard presented to the Idea Program 2024, and won 1st Place. The goal of the project is to a gamified the learning management system, and guide user's with their journey, skills, and role development.

The following are the unique gamified features offered in the dashboard that may differentiate to a traditional:

Features

(back to top)

Built With

  • Ruby on Rails 7.1.3
  • Ruby 3.3.0
  • Tailwind CSS
  • Stimulus JS

(back to top)

Getting Started

The following are the prerequisites and guides on how you can use this project:

Prerequisites

This project requires:

  • Ruby 3.3.0, preferably managed using [rbenv] or [asdf][]
  • Chromedriver for Capybara testing
  • PostgreSQL must be installed and accepting connections
  • [Redis][] must be installed and running on localhost with the default port

On a Mac, you can obtain all of the above packages using [Homebrew][].

If you need help setting up a Ruby development environment, check out this Rails OS X Setup Guide, make sure you check the version of your device.

Getting Started

To get started with the app, clone the repo and then install the needed gems:

$ gem install bundler -v 2.5.6
$ bundle _2.5.6_ config set --local without 'production'
$ bundle _2.5.6_ install

Create the database :

$ rails db:create

Next, migrate the database:

$ rails db:migrate

$ rails db:seed # optional

Finally, run the test suite to verify that everything is working correctly:

$ rails test

If the test suite passes, you'll be ready to run the app in a local server:

$ rails server or bin/dev

(back to top)

Usage

You can use this project whenever you want, get the idea, and implement it to your own learning management system. I believe the features of this project has benefits and impacts to organization when use rightfully. You can copy all the code examples all you want, but leave the images, logos, brandings, etc. as those are owned by the artits, member of this project.

(back to top)

License

Distributed under the MIT License.

MIT License

Copyright (c) 2024 Dan Ray Rollan

Credits to the Idea Program 2024 of SupportNinja Inc.

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.

(back to top)

Contact

Dan Ray Rollan - @instagram/danrayfr - [email protected]

Github Profile: https://github.com/danrayfr/

(back to top)

Acknowledgments

Many thanks to the following:

  • The Idea Program 2024 of SupportNinja Inc.

(back to top)