Challenge Overview
Challenge Objectives
-
Custom CMS (content management system) called Zeta, Yelp API, basic HTML / Javascript
- This challenge will be a proof of concept to show that we can build Zeta CMS “components” that call a job search API and show the results. Separate components will be built for the search input and displaying the results.
- ���We've built a similar component recently for Yelp, and this challenge can use that to see how we can implement the new search components.
Project Background
-
We will be building out a few sites that use Zeta and provide new functionality for the client.
-
This challenge will show that we can do what the client is going to need, as well as properly deploy and use the Zeta CMS.
-
We will be building a map component based on the jobs API after this, so there will be multiple challenges using this jobs API and using the jobs components.
Technology Stack
-
Zeta is built on Node.js, MongoDB, and MySQL
-
Zeta is tough to deploy by itself, so we have provided a Vagrant setup that should be easily deployable through `vagrant up`
-
Details on deployment and the test user to use at login will be provided in the forum
Individual requirements
For this challenge, we will build and deploy two Zeta components, detailed below. A Zeta developer guide will be provided as part of the Vagrant deployment Git repository to help guide members.
The requirements can be found in this ticket: https://gitlab.com/hercules-jobs/project-resources-jobs/issues/14
Access to the Gitlab repo can be found in the forum.
Search API
The job service should be integrated into the service-static app in the Zeta deploy, allowing for global usage from future components. See the Services API section of the Zeta developer guide.
UI Requirements:
Your components should follow the UI given in the MarvelApp links in the ticket above. Existing components do this already, and you can use those components to help implement these new ones.
General guidelines:
Our Zeta resources (see the developers guide) will follow the existing naming convention and will be called project-resources-jobs
Deployment guide and validation document
Make sure to require two separate documents for validation.
A README.md that covers:
-
Deployment: How the components are installed in Zeta, added to a DocDef, and then shown on a document.
-
Configuration: How do we configure the API details for the search API?
-
Dependency installation: What new dependencies are required and how are they installed?
A Validation.md that covers:
-
How the deployed components are used, showing a couple test cases, including errors.
Validation video / screencast
-
A video is required for this challenge.
What To Submit
-
Component code as patch files to the existing repositories in Gitlab. Please target a commit hash and document the hash in your README so that reviewers can apply the patch easily. Make sure to test your patch files!
-
README.md
-
Validation.md
-
Link to your validation video