Digital Style Guide - angular.material.io exploratory and customization

• Target environment: Desktop computers, Mobile phones, Tablet, Angular Web app

• Basic Requirements: Investigate if material.angular.io meets the requirements

 

Project Background

Digital Style Guide is an interactive tutorial web application. The features are similar to https://material.angular.io/components/categories.

 

Technology Stack

• Node 12

• Typescript

• Markdown

• Angular 8

• SCSS

• StoryBook

• Angular Material

• Nx Workspace

Individual requirements

 

In this challenge, we would like to investigate if material.angular.io meets the following requirements

1. Interactive markdown editing for adding documentation for components. The users are able to author components and flow directly inside material.angular.io application. Specifically, it includes

   1. Generate obscured URLs that only certain users know, the users can access to these URLs to edit the documentation in markdown.

   2. The documentation in markdown should be stored in separate .md files so that the users can even edit them offline.

   3. We don’t need any SSO login system.

2. Work with Nx Workspace as a mono repo.

3. Support to customize styling and layout.

4. Responsiveness on different sizes of screens.

 

If material.angular.io meets all the above requirements, please fork the material.angular.io and customize it to meet all the requirements above.

 

For customized styling, we need to follow the style guide of the given prototype and code base. (I’ll provide the https://invis.io/B9SETBPAPJ2 and the style-guide.zip) in the forum.

 

If material.angular.io doesn’t meet any of the above requirements, please provide detailed documentation to explain why it can’t meet the requirement. Also, please build an Angular 8 application without Storybook that meets all the requirements above. 

 

Important notes

If you have any questions, feel free to ask in the forum. Any assumption without approval won’t be accepted.

The submission will be reviewed subjectively by the copilot and the client, no appeal and appeal response applied.

Final Submission Guidelines

Please submit the following items in a zip archive.

 

- The source code of your application (with or without material.angular.io), if your submission is based on material.angular.io, please include a git patch against the latest/specific commit hash of the material.angular.io repo, master branch. 

- A detailed README.md to describe how to build, deploy and run the application.

- If your application is without material.angular.io, please submit another separate document to explain why material.angular.io can’t meet the requirement.

- A video to verify your application meets all requirements. If you are not comfortable with spoken English you may feel free to annotate your video with text.