RyanFleck / Xalgo-System-Prototype

Backend for the fourth toy prototype xalgorithms internet-of-rules .rule editor.

Home Page:https://xalgo-system.herokuapp.com/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool



MOVED: https://gitlab.com/xalgorithms-alliance/Xalgo-DevRM-v1




Xalgorithms System v0.4 Dev Backend

CI codecov Updates

This React/Django system is the fourth prototype in the series of visual rule editors, and the most complete. It contains the the code to deploy a frontend and backed from the same Heroku container for easy sharing, discussion, and iteration.

Frontend at https://github.com/RyanFleck/Xalgo-System-Prototype-FE

Unit Test Coverage

Code coverage

Usage

Casual users can simply browse to https://xalgo-system.herokuapp.com/, create and verify an account, then begin testing. The account verification email may arrive in your junk mail. For further instructions please read all the documentation written on the homepage.

Development

Install Docker Desktop on Windows 10/OSX, or docker and docker-compose on GNU/Linux, then run the following to build and run the system, including all required services, locally:

docker-compose -f development.yml up

Use pre-commit to keep code quality up: pre-commit install

Write unit tests to make this codecov sunburst graph of unit test coverage look better:

Sunburst graph, unit test coverage

Submitting Work

When adding new features, please use the semantic commit labels so version bumps are accurate:

  • feat: A new feature
  • fix: A bug fix
  • docs: Documentation only changes
  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
  • refactor: A code change that neither fixes a bug nor adds a feature
  • perf: A code change that improves performance
  • test: Adding missing or correcting existing tests
  • chore: Changes to the build process or auxiliary tools and libraries such as documentation generation

Resources

  1. A previous deployment experiment: https://github.com/RyanFleck/Django-React-Heroku-Test
  2. JWT Tutorial: https://hackernoon.com/110percent-complete-jwt-authentication-with-django-and-react-2020-iejq34ta

About

Backend for the fourth toy prototype xalgorithms internet-of-rules .rule editor.

https://xalgo-system.herokuapp.com/

License:GNU Affero General Public License v3.0


Languages

Language:Python 49.3%Language:HTML 44.2%Language:Shell 3.6%Language:Dockerfile 2.3%Language:SCSS 0.4%Language:CSS 0.2%Language:JavaScript 0.0%