Challenge Overview
Challenge Objectives
- Topcoder-X is a node web application used by copilots to manage direct tasks.
- This challenge will implement changes based on user feedback and clean up some bugs that have been logged.
Project Background
Topcoder-X is a new framework we are building to allow for easy, transparent integration with Gitlab and Github for managing tasks on Topcoder through Gitlab and Github issues. Each issue on Gitlab or Github will be automatically associated with a specific challenge on Topcoder and this challenge will be updated automatically for assignee, prize, etc... and it will be opened and closed for payment as the Gitlab or Github ticket is opened, modified, and closed.
This challenge is part of a long-term series that will tweak the existing functionality based on feedback from copilots, fix bugs, and will implement new functionality.
Technology Stack
- NodeJS is used as the main language for Topcoder-X.
- DynamoDB is used for data storage, and Kafka is used for message queueing.
- We currently deploy to Heroku. There are 3 instances needed - receiver, processor, and the UI
- Note that this environment takes a fair bit of configuration to get all the pieces set up and working together. Please ensure you budget a proper amount of time to work through deployment issues.
Code access
There are currently three pieces to this app:- Topcoder-X Receiver (https://github.com/topcoder-platform/topcoder-x-receiver)
- Topcoder-X Processor (https://github.com/topcoder-platform/topcoder-x-processor)
- Topcoder-X UI (https://github.com/topcoder-platform/topcoder-x-ui)
The UI is going to be used by copilots and others to set up the necessary settings for individual projects in Topcoder-X, including all the repo and Topcoder project information. It will also be used by copilots to have a centralized view of all their projects at once.
You can find detailed information on deployment and configuration here. You can use DynamoDB locally if you want: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DynamoDBLocal.html
https://github.com/topcoder-platform/topcoder-x-ui/blob/develop/TopcoderXDeploy.md
A general user guide can be found here:
https://github.com/topcoder-platform/topcoder-x-ui/wiki
Individual requirements
These tickets are the requirements for this challenge:
- https://github.com/topcoder-platform/topcoder-x-ui/issues/153 (Major requirement)
- https://github.com/topcoder-platform/topcoder-x-ui/issues/152 (Major requirement)
- https://github.com/topcoder-platform/topcoder-x-ui/issues/148 (Minor requirement)
- https://github.com/topcoder-platform/topcoder-x-ui/issues/150 (Major requirement)
- https://github.com/topcoder-platform/topcoder-x-ui/issues/154 (Minor requirement)
- https://github.com/topcoder-platform/topcoder-x-ui/issues/149 (Minor requirement)
- https://github.com/topcoder-platform/topcoder-x-ui/issues/147 (Major requirement)
Deployment guide and validation document
You must provide a README.md that covers:
- Local deployment
- Heroku deployment
- Configuration for the receiver, processor, and UI
A comprehensive Validation.md that covers:
- How to validate the individual fixes. Please ensure that you address each individual bug ticket directly. This needs to be comprehensive - a one-sentence description likely won't be enough. Please provide screenshots as well.
Validation video / screencast
No video is required for this challenge
���What To Submit
- A patch file that targets the “develop” branch of https://github.com/topcoder-platform/topcoder-x-ui
- A patch file that targets the “develop” branch of https://github.com/topcoder-platform/topcoder-x-processor (if needed)
- Ensure your patch file updates the deployment documentation in the README, if necessary
- A Validation.md that covers the details above