Skip to content

Latest commit

 

History

History
39 lines (32 loc) · 2.62 KB

solution.md

File metadata and controls

39 lines (32 loc) · 2.62 KB
Raw

Purple Cow

Below is my explanation and implementation of the task provided by Fearless

Requirements

At the initiation of this project, I took some notes for my approach to make sure each requirement provided was being addressed.

Requirement Implementation
Web application interface that uses Javascript and HTML that is served on port 3000 Express will use environment variable for the port provided by docker
Use the https://countapi.xyz/ api to manage counting; a. Key: 1ccb732e-b55a-4404-ad3f-0f99c02fe44e Creating a method for incrementing the counter based off of returned value from API
Provide a single button to “hit” the counting api and display the current number of hits OnClick method for button to send API and update state
Runs locally with a single startup command Docker command will be used
Should run correctly in Chrome; don’t worry about cross-browser compatibility Testing and development will be done in Chrome
Includes a solution.md that provides relevant documentation including how to build and run the solution solution.md will include how to build and run the application
Includes a Dockerfile that will run and serve the web application Docker file will run the app
Any components are reusable (i.e. could have multiple copies on the same page) Using ReactJS to make re-use of components easier, and will contain the button and counter in a single parent component
The port the solution is served on is configurable and documented in the solution.md Dockerfile will set the port to be used by Node/Express

Additional Notes

Future Updates:

  1. Adding styling to the components would be the next phase.
    • This includes a prettier loading animation
  2. Testing using tools like Jest and Enzyme would be added to make sure the original Counter functionality was not lost.

Assumptions:

  1. With this being a proof-of-concept, I did not add styling to this application.
  2. State was added at the root component so that in the future, if additional counters were rendered, they would all update from any Hit being clicked.

Build and Run the App

To build docker image:

  1. Open the terminal or command prompt in the directory of the app
  2. Run the following: docker build -t landro3/purple_cow .
    • Make sure to include the "." at the end of the command

To run the container:

  1. Open the terminal or command prompt in the directory of the app
  2. Run the following: docker run -p 3000:3000 --name purple_cow -d landro3/purple_cow
    • Changing the first 3000 in 3000:3000 will change the port the solution is served on