Challenge Overview
Project Overview
TopCoder is implementing a Web-based Arena by using Web Socket protocol, AngularJS Framework (http://angularjs.org, http://docs.angularjs.org/guide) and Bootstrap 3 (http://getbootstrap.com/getting-started).
The frontend application is using AngularJS Framework (http://angularjs.org, http://docs.angularjs.org/guide) and Bootstrap 3 (http://getbootstrap.com/getting-started), and using web socket protocol to exchange data with backend web socket listener.
The backend web socket listener is ready for exchanging messages over web socket protocol.
Competition Task Overview
For web arena, the latest code can be found at cloudspokes/arena-web.
We are in the tight time to implement the Problem-based practice feature. Currently, a challange (Fast 96hrs!!! Module Assembly - Practice Problem Listing Page) is running to implement the Practice Problem Listing Page, like the following screen
the next step is when clicking any problem name, it will open the Code Editor to compile, test and submit.
Scope
For this challenge, we'd like to prepare and test with functionality for Code Editor. so we can easily integrate with the Problem Listing Page.
Current Situation
Please check https://github.com/cloudspokes/arena-web/tree/md-practice, we have done some PoC, you can play with it. It is using hard code (roundId, problemId, divisionId, roomId).
Based on that we'd like to do the following requirements in this challenge.
- Refeactor logic to be generic, it will take the parameters (roundId, problemId, divisionId, roomId, etc) in order to open the problem to practice (code, compile, test and submit). So it can be easily called in the Practice Problem Listing Page. Please keep this in mind.
- Currently, the PoC is reusing the Coding state for Code Editor, which is used actually used for Coding phase during the SRM, the UI need some slight tweak to Practice mode, like the Back to Match button should be hidden. Please create a new Practice state. which can be used to implement specific functionality for Practice in the future.
- Currently, the problem can not be properly closed, like you click the Practice Problems icon (second Bug icon), you will get error like
we'd like to make sure the problem be closed properly for most cases, like navigating to other pages, open another problem etc.
Themes
there are three themes, please make sure the UI looks good in these three themes, since we are reusing the Code Editor, this should be not a big problem, but be sure to test with.
Configuration
Please make the domain related information configurable as others, see dev-local.sh. So we can easily switch for different environment.
Where to setup the Arena Web
You are expected to have your own environment to setup web arena, Linux environment is perferred.
for backend, an Arena VM will be allocated to each competitor, to setup SRM contests datas.
Winner Responsibility
Winner will be responsible to:
1. Create pull request in final fix phase for merging.
2. When the Practice Problem Listing page is ready, help with the integration to make it completely work.
About Code Base
For the code under /home/apps/dev directory, some are hosted in internal svn repositories, some are hosted in private repositories in github.
You can check Source Code Management For TopCoder Competition Engine - TopCoder Wiki
For SVN Access, please send request to support@topcoder.com, For github access, please post your github account in forum to ask PM to grant you access.
Arena VM
Before asking your own VM, you need to have a public key on your profile before asking for the VM.
You can find more details on how to generate a key http://apps.topcoder.com/wiki/display/projects/Generate+SSH+Key and how to connect using it http://apps.topcoder.com/wiki/display/projects/Connect+Using+SSH+Key.
To use the Arena VM, please follow http://apps.topcoder.com/wiki/display/docs/Competition+Engine+VM+Setup
Specific HTML/CSS/JavaScript Requirements:
HTML/CSS Requirements:
- Your HTML code must be valid HTML5 and follow best practices
- Validate your code - reviewers may accept minor validation errors, but please comment your reason for any validation errors. Use the validators listed in the scorecard.
- Use CSS to space out objects, not clear/transparent images (GIFs or PNGs) and use proper structural CSS to layout your page. Only use table tags for tables of data/information and not for page layout.
- No inline CSS styles - all styles must be placed in an external style-sheet.
- Use semantically correct tags - use H tags for headers, etc. Use strong and em tags instead of bold and italic tags.
- 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)
- Label all CSS, JavaScript, or HTML hacks with explanations so others will understand.
- Your code must render properly in all browsers listed in the scorecard in both Mac and PC environments.
JavaScript Requirements:
- jQuery
- AngularJS
- All custom javascript (written by the competitors) must pass jslint checks
Browsers Requirements:
- IE10
- IE11
- Latest Safari
- Latest Firefox
- Latest Chrome
Final Submission Guidelines
Submission Deliverables
Below is an overview of the deliverables:
- please only include changed files (removed, new and changed) with git commit hash.
- A complete and detailed deployment document explaining how to deploy the application including configuration information.
Final Submission
For each member, the final submission should be uploaded to the Online Review Tool.
PROTOTYPE GOALS:
- We need clean documentation of the code. Please create detailed comments for the different HTML5, CSS3 and JavaScript code.
- Please note, we are expecting the HTML5 prototype to work on mobiles.
- Use CSS3 Media Queries to load different styles for each page and don't build different page for different device/layout.
- Remember, all pages should link where possible. Please help us show correct page flow.
- Please use Bootstrap 3 for css.
- Please use AngularJS framework for data binding.
- Please use angular-ui components:
1- ui-bootstrap
2- ui-router (for app structure as a state machine)
3- ui-ace or ui-codemirror (for the code editor)
4- other ui components as needed (date, calendar)
TECHNOLOGY GUIDELINES:
1. HTML5
- Provide comments on the page elements to give clear explanation of code usage. The goal is to help future developers understand the code.
- Please use clean INDENTATION for all HTML code so future developers can follow the code.
- All HTML code naming should not have any conflicts
- Make sure all HTML files pass Validation without Error/Warning.
2. CSS3
- Provide comments on the CSS code, we need CSS comments to give clear explanation of the code usage. The goal is to help future developers understand the code.
- Please use clean INDENTATION for all CSS so future developers can follow the code.
- All CSS naming should not have any conflicts
- Make sure all CSS files pass validation without Error/Warning.
3. JAVASCRIPT
- Provide comments on the JavaScript code to give clear explanation of the code usage. The goal is to help future developers understand the code and know what needs to be developer further.
- Please use clean INDENTATION for all JavaScript code so future developers can follow the code.
4. ANGULAR JS
- Angular models are plain old JavaScript objects. Use JSON objects for data binding with view.
- Data-binding is an automatic way of updating the view whenever the model changes, as well as updating the model whenever the view changes.
- Controllers are the behavior behind the DOM elements. AngularJS lets you express the behavior in a clean readable form.
- Use AngularJS Framework (http://angularjs.org, http://docs.angularjs.org/guide) to populate JSON data.
5. IMAGES
- For mobile development, images should be properly compressed while still having good visual quality.
- If possible, using background color properties, instead of repetition usage of background based image.
- Use sprites technique for the image slicing. Page reference