Challenge Overview
1.1 System Description
The client for this project built a platform that supports the sale, exchange, and redemption of gift cards between businesses and individuals. The goal of this platform is to help small businesses expand, using both web and mobile layouts, by giving them a simple way to raise capital and acquire new customers using gift cards. The main function of the platform will be to allow business to post virtual gift cards for sale on the platform. Individual users will be able to browse and buy these gift cards, as well as resell or trade gift cards they own. Using the mobile layout, users will be able to redeem their gift cards at the business, and the business will be able to process gift card redemption at their point of sale.
A brief desription of the workflow is attached. The platform is already live https://foundershare.com but requires various enhancement to satisfy all user needs. You can also check out the Sandbox at https://qa.foundershare.com/#/ to pass the end-to-end flow without paying with a real credit card (just a fake one number 4111 1111 1111 1111 is enough).
This assembly is responsible for implementing features related to social media sharing and sending gifts processes revamp.
1.2 Competition Task Overview
ATTACHMENTS ARE POSTED AT THE FORUM
1.2.1 Scope
-
PMP-284 Track Gift returned actions in actionrecords schema.
-
PMP-261 Champion must be able to send a gift to any of her g-mail contacts. There is no UI design for it so please use your best judgement regarding user experience. Existing styles has to be reused.
-
PMP-271 Gift accepting optimization: no need to accept the gift if the addressee is already registered in F$
-
PMP-272 Resend Gift link won't work if a user has not logged in before opening it
-
PMP-278 No need for e-mail verification for those who came to sign up from a gift e-mail message
Full requirements description is attached in the Document section of the Forum.
Non-functional
1.2.2. API and DB update
When/if you create new API and/or update DB schema please ensure that:
- API is secure and checks ID of the requesting client: no user (Individual or Business) shall have access to another user data via API unless they are authorized. E.g. Business Owner shall not be able to view gift cards of another business calling API with another business ID parameter.
- new API it is covered with unit tests.
- updates to the DB schema are documented in a dedicated file and please provide a mechanism that will fill new fields of the existing records with empty valid value. E.g. of being NULL, a numeric field shall be 0, string field - be "n/a", ZIP code - 00000 etc.
1.3 Approval phase
- Since the codebase may be updated in parallel, the winner may be asked to merge the codebase (mostly integrating the code of this assembly into the main branch).
- Some minor UX/UI fixes may be requested by the client during approval phase.
Final Submission Guidelines
- Working Codebase
- Updated deployment guide
A complete list of deliverables can be found in the TopCoder Assembly competition Tutorial at:
http://apps.topcoder.com/wiki/display/tc/Assembly+Competition+Tutorials
If anything deployment/configuration related needs to be added to the existing deployment guide, please do it in Edit mode (MS Word). The verification steps for this assembly must be provided in a separate file to avoid any confusion.
- The working app is available at https://www.foundershare.com/ (Production) and http://www.qa.foundershare.com/ (QA).
- The current codebase is posted at the forum.
Change log must be added to all JS files that you’ve updated. It must contain
-version of the file;
-name of assembly;
-jira ticket id (if applicable).