Home - Fruit-of-Binary-Tree/Documentation GitHub Wiki
What is a public peer review?
A public peer review system enables a user to post reviews on research papers, books etc. A user will be able to create a post based on the paper with the certain categories (title, description, author etc.) that they think is an educational paper that will be of help to others. Other users may comment on these posts to post their opinion of useful the actual paper is and as well rate it. Having this kind pf system gives insights to users on useful a certain paper may be and the quality rating of the paper. The system will as well have an additional component of searching for a paper in the system and it gives all of the google scholar results.
Team Members:
Written in the form: Name Surname (Student Number)
-
Aashna Gaogle (2202103)
-
Abigail Naicker (2350973)
-
Harshan Pillay (2344696)
-
Que Sera Subramoney (1611459)
How will we go about creating this system?
In creating the software system, react will be used as the framework which uses javascript and type-script language. React has fast rendering. It has one UI design and using a single code base has one user interface and can be used one both platforms which saves development time.
Codecov will be used for the code coverage part of the project and circle ci, will be used for the continuous integration.
GitHub will be used as the software configuration management software. An issue tracker on GitHub will be used to keep track of any issues we approach and when it has solved. The Kanboard on GitHub will also be used as our scrum task board which shows our product backlog and the tasks and features to be completed.
Type of architectural styles used:
More information in Software Architecture and Design Page.
Testing Methods Used:
Every time a new contribution is made, run unit tests on changed components, regression tests on unchanged components to make sure they still work as intended and run integration tests on the whole system.
- Unit Testing
- Integration testing
- Vertical Integration Testing