To Run 👟

• PREREQ: node 14 (if using nvm) NOTE: May work on other versions, but untested. (Create React App does not work out of the gate with Node 17)

  • nvm ls
  • nvm install v14.15.5 (if not already installed)
  • nvm use v14.15.5

• Install NPM Dependencies npm i

Development 🚧

• Run app with npm: npm run start or npm start

Production 🚀

• Build App via npm : npm run build

  • this will create a /build directory at the project root level

• Run Production Build via http-server : npx http-server ./build

  • If http-server is installed globally (npm i -g http-server) then you can alternatively run http-server ./build
  • Additional server configuration may be wanted, but defaults will be port : 8080.

Troubleshooting 👾

• Is your port busy? You may need to kill the process on that port or change the runtime port.
• Do you have the correct version of node installed?
• Have you ran npm i?
• Sometimes npm can be wierd, try cleaning node_modules/ and re-installing or runnning npm ci

Figma Design File

I designed this project with Figma, check out my Design File.

Future Efforts

Run with Docker

- TBD

Tests ✅

Run

• npm : npm run test

However, at this time there are no tests :(

----- Bootstrapped CRA Docs -----

This project was bootstrapped with Create React App.

Available Scripts

In the project directory, you can run:

npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

npm test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

npm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

npm run eject

Note: this is a one-way operation. Once you eject, you can’t go back!

If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.

You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.

Learn More

You can learn more in the Create React App documentation. To learn React, check out the React documentation.

----- Ends Bootstrapped CRA Docs -----