Create an .env file and copy the contents of .env.example, insert your own Yelp API key
See requirements and designs
I opted to go against the guidelines in one important way: I decided to use NextJS which may fall within the bounds of "Do not use any React boilerplate, such as Create React App". What this means:
- The project comes with a bunch of out of the box features, optimizations, etc
- I won't be showing: technical skills related to routing, bundler tooling, bundle optimization, or establishing server side rendering (I can speak to/provide examples of these as needed)
- I will be showing: writing clear, concise, testable and transferable code that is not specific to this or any other React template
- Why I chose to do this: I wanted to deliver quickly while focusing on the core "what you should strive for" skills, NextJS provides an extremely easy to establish API which I used to proxy the Yelp API and is readily deployable to a service like Vercel
I opted to use a local Storybook deployment tool (that can be setup as part of a CI/CD pipeline as well) and Github pages simply down to ease of implementation. In its current state, it requires a developer to run the deployment command, but ideally for a long-standing production application this would be automated to be kept up-to-date
A valid .env file is required for these to be successful
Creates a production build
Runs linter, interactive Git file selector, and then git-cz for clean, consistently formatted commit messages
Runs both sub GraphQL scripts in parallel.
Creates a GraphQL schema file based on the connected GraphQL API for use with IDE GraphQL tools that provide intellisense when writing queries
Creates a Typescript file with all types on the connected GraphQL API via introspection, as well as queries and hooks generated from within this codebase
Runs the linter on the entire project
Serves a production build (must be built previously)
Runs the development build and server and watches the codebase for changes
Runs Storybook locally
Creates a static version of the Storybook build
Pushes a static Storybook build to the gh-pages branch on Github which will update the Github Pages site
Runs the tests within the entire project
Runs tests as well as collects test coverage
Runs an interactive tool to check for new versions of existing dependencies, allowing for selective upgrading