Skip to content

Latest commit

 

History

History
74 lines (43 loc) · 2.49 KB

README.md

File metadata and controls

74 lines (43 loc) · 2.49 KB

A Simple Dictionary application.

A simple dictionary application that uses https://dictionaryapi.dev underneath to find meanings.

Tech-stack

  • TypeScript
  • React
  • Redux Toolkit
  • Emotion
  • React Testing Library
  • Jest
  • Cypress

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 test:coverage

Runs the unit tests with coverage.

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.

npm run cypress:open

Opens Cypress dashboard and you can run the tests from there.

npm run lint

Runs linter on the codebase.

npm run prettify

Formats the codebase based on prettier config.

npm run predeploy

Builds the application as part of deployment and runs automatically before the deployment script.

npm run deploy

Deploys the application to GitHub pages and can be accessed from What does it mean