Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Separate the reporting suite front end (Flask application) from the backend. #65

Open
KevinFasusi opened this issue Sep 17, 2018 · 0 comments
Assignees

Comments

@KevinFasusi
Copy link
Owner

Currently, the core logic and the reporting suite are in the same library, separating the two components of the project will:

  1. Help maintain the orthogonality of the codebase and keep the code decoupled. Fixing bugs, making enhancements in either the core logic or the reporting suite should not have side effects.

  2. Make it easier to work on the project in smaller sprints.

  3. Make it easier to document.

  4. Allow dependencies to be precise.

  5. Remove the requirement for a full release of the library when bugs get announced in dependencies for the frontend (some javascript libraries).

  6. Make it easier to contribute to the frontend by reducing the need for domain knowledge. I spoke with a UX/UI company about the reporting suites and summarised the responses in this blog post.

  7. Improve the test coverage and completeness. The current test suite does have unit tests but not functional tests (there are a few basic ones).

  8. Help keep the codebase Pythonic and reduce technical debt and "code smells".

These are some of the main points I think make separating the project a sensible decision. If there is anything else to consider, please comment.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants