Giter Club home page Giter Club logo

hajime's Introduction

DUE TO LACK OF TIME, THIS PROJECT HAS BEEN ARCHIVED. MAYBE ONE TIME I WILL BE ABLE TO TAKE TIME AND REWORK THE PROJECT TO A FULLY FINISHED AND USABLE APP. THANK YOU FOR THE SUPPORT.

logo

MIT License

Special Sponsors

lokalise_logo

Hajime

Hajime is an Electron application for managing Kendo competition

Supporting Hajime

Hajime is an MIT-licensed open source projet with its development made possible entirely by the support of these backers. If you'd like to join them, please consider:

Project status

The project is currently slowed down due to lack of resources (currently only the main author is working on Hajime):

  • Developers that want to contribute to the project
  • Donations that can help actively growing the project and finish the MVP that every Kendo's dojo can use it in a Kendo competition event

Roadmap (MVP)

TODO: add details, explanations, images

  • ✅ Competition creation workflow
    • ✅ General informations
    • ✅ Importing fighters or teams
    • ✅ Setup the competition formula (rules)
  • Competition 'D-Day' workflow
    • ✅ Fighters/Teams list review and lock
    • ✅ Pools (Todo: more detail)
    • ✅ Fight scoring
    • Tournament bracket in the same UX/UI than Pools (Todo: more detail)
  • ✅ i18n (:fr:, :gb: for the begining)
  • Marking board
  • Live-scoring application
    • Slave application connected to a master application through socket.io
    • Must work without internet (local network)
    • Reflexion about making an mobile / tablet app (using Flutter, React Native, etc.) or keep using Electron as it can be installed on a windows tablet (can be enough)
    • It should share a part of the components as we already handle list of fights, fight scoring, etc...

Scoring application

Installation

Dependancies

These dependancies are required to launch the project :

  • NodeJS
  • Yarn (More reliable than npm to manage packages)

Then you need to install the project dependancies by launching yarn

Scripts

Defined in package.json :

  • yarn dev : launch the application in development mode
  • compile : Compile source code with webpack
  • build : Create an executable installation on the current OS environment
  • build:fast : Faster build only for test purposes in production mode
  • postinstall : Compile binaries dependancies (eg. drivers like mysql, sqlite, etc.)

Technical details of the project

Main technologies and libraries

Directory structure

  • /dist : contain production files when yarn build was used
    • /src/main : main process of Electron
    • /src/renderer : render process of Electron
      • /src/renderer/index.js : Entry point
      • /src/renderer/App.vue : Vue JS entry point
      • /src/renderer/assets : Images, fonts, etc...
      • /src/renderer/screens : VueJS components which are screens of the app
      • /src/renderer/database : Contain all files related to the database. models definition, sequelize, migrations
      • /src/renderer/plugins : Custom Vue JS components loaded as a plugin
      • /src/renderer/router : Vue-router configuration files
      • /src/renderer/store : Vuex files
  • /database : Mysql workbench files
  • /webpack/webpack.renderer.additions.js : Webpack's override configuration
  • .env : environment variables

Contributing

You can contribute to Hajime by following CONTRIBUTING.MD

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.