Challenge Overview
Welcome to the GnG code refactor | cts Challenge. In this challenge, we are looking for you to refactor the existing Angular 2+ Code based on the requirements below.
Technology Stack
- NodeJS
- Angular 7
- JavaScript
- REST
General Requirements
Data Loading & Alerts
- Use loading animation effect to show the progress when loading data.
- Sanck-bar/toast should be used to show the error, success & warning messages when data is loaded from API. It shouldn't be shown for every successful API call, use your best judgment to show these.
Code Quality
- Reuse the existing code, components, CSS, js, etc as much as possible instead of duplicating the code.
Code formatting
- Make sure code is well documented, all classes, methods, variables, parameters, return values must be documented in every single code file, and appropriate inline comments should be provided too where the code is not straightforward to understand.
- Please use clean INDENTATION for all HTML code so future developers can follow the code.
- Use appropriate linter to validate your code.
Framework specific
- Use Observable & Observable.subscribe() method wherever applicable. You may refer this: https://angular.io/tutorial/toh-pt4#subscribe-in-heroescomponent
- Use Dependency Injection coding pattern.
-
ng build
should work without throwing any error. - All type of responses
200, 401, 403 & 404
should be handled.
HTML Specific
- HTML should be valid HTML5 compliant.
- All HTML code naming should not have any conflicts or errors.
- Element and Attribute names should be in lowercase and use a '-' or camel naming to separate multiple-word classes (i.e.. 'main-content', or 'mainContent)
- Use semantically correct tags- use H tags for headers, etc. Use strong and em tags instead of bold and italic tags.
- No inline CSS styles- all styles must be placed in an external stylesheet.
CSS Specific
- Use CSS3 Media Queries to load different styles for each page. Do not build a different page for different device/layout.
- You may use SCSS in the project.
Platform
- Desktop: Chrome latest, Firefox latest (Mac & Windows), Safari latest (Mac), IE11+ (Windows), MS Edge
App Requirement
0 Resources & links
- API mappings, API details, base submission & storyboard details are provided in the challenge forum.
- Base branch is dev
- Storyboard
- Most of the code of
cts
module is kept inside app/cts folder. While refactoring only update the codes in this folder,ui\src\app\shared
&ui\src\app\routing
folder. Avoid doing changes in other folders unless it's required.
1 Code duplicity
For directory structure only ref: https://d.pr/free/i/WQ5ur2 from the master branch code: https://gitlab.com/gng-taasgroup/gng-toolkit/tree/master/ui/src/app/shared
- Get rid of code duplicity, you should move the code present in calculator specific
shared
folderto common shared folder kept directly under the app directory
/src/app/shared`.- Move the code present in the calculator specific
core
folder to a common core folder kept directly under the app directory/src/app/core
2 Update the selectors
- ref: https://d.pr/free/i/3oUXU4
- Upldate element selectors to match your module name (in this case, component name should start with cts-, i.e. definitely not from xrd-)
3 Update icons to use font-awesome icons.
- ref: https://marvelapp.com/1fj39i6g/screen/58733924
- The pdf icon everywhere in the
cts
module should be using font-awesome icon https://fontawesome.com/icons/file-pdf?style=regular- The csv icon everywhere in the
cts
module should be using material icon https://fontawesome.com/icons/file-csv?style=regular- icon color for both should be same as in Storyboard
Final Submission Guidelines
- Full source code with all the requirements implemented.
- Detailed readme in markdown format that describes how to configure, build and run the app.
- Verification video or doc.
Licenses & attribution
- Third-party assets used to build your item must be properly licensed or free for commercial use. MIT, some modified BSD, Apache 2 licenses are ok. If a library is not commercial friendly you will need to get our approval first.
- Sufficient information regarding third-party assets must be present in your documentation. This includes the author, license info and a direct link to the asset online.
FAQs
After submission as a submitter what should be my next step?
Once the challenge submission phase is over the assigned reviewers are going to review all the submissions based on the challenge scorecard. They are expected to raise all issues found in the submissions they are reviewing. After the completion of review phase the Appeal phase status. In this phase, the submitters should go to the Online Review page, select the project & have a look at the issues raised by the reviewers. If you disagree with the reviewer on any issue/comment, raise an appeal by clicking the 'Appeal' button associated with the section and entering the appeal comment.
When & where I can see the challenge results?
After the Appeal response phase is over the results are displayed on the challenge specification page as well as on the online reivew page.