Skip to content

Commit

Permalink
edit readme.md file
Browse files Browse the repository at this point in the history
  • Loading branch information
Ahmed Mohamed committed Jun 26, 2022
1 parent c5849ab commit 872fd76
Showing 1 changed file with 32 additions and 52 deletions.
84 changes: 32 additions & 52 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,70 +1,50 @@
# Getting Started with Create React App
# QR App

This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
This is the **Frontend Source Code** for [**QR App**](https://qr-app-peach.vercel.app/).

## Available Scripts
---

In the project directory, you can run:
# Discreption

### `npm start`
QR App is an app for Creating and Scanning QR Code in The Fastest Way and Completely Free.

Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in your browser.
---

The page will reload when you make changes.\
You may also see any lint errors in the console.
# App Features

### `npm test`
- Reponsive
- Nice Design with Tailwind Framework
- Speed & Good Performance with Tailwind Framework
- Nice Animations

Launches the test runner in the interactive watch mode.\
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
---

### `npm run build`
# Languages & Technologies

Builds the app for production to the `build` folder.\
It correctly bundles React in production mode and optimizes the build for the best performance.
### Languages That used in this Web App:

The build is minified and the filenames include the hashes.\
Your app is ready to be deployed!
<div style="display: flex; justify-content: center; align-items: center; gap: 20px;">
<a href="https://developer.mozilla.org/en-US/docs/Web/HTML"><img src="https://img.icons8.com/color/48/000000/html-5--v1.png" alt="drawing" width="48" height="48"/></a>
<a href="https://developer.mozilla.org/en-US/docs/Web/CSS?retiredLocale=ar"><img src="https://img.icons8.com/color/48/000000/css3.png" alt="drawing" width="48" height="48"/></a>
<a href="https://www.javascript.com/"><img src="https://img.icons8.com/color/48/000000/javascript--v2.png" width="48" height="48"/></a>
</div>

See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
### Technolohies & Frameworks that used in this App:

### `npm run eject`
<div style="display: flex; justify-content: center; align-items: center; gap: 20px;">
<a href="https://reactjs.org/"><img src="https://cdn-icons-png.flaticon.com/512/3334/3334886.png" alt="drawing" width="48" height="48"/></a>
<a href="https://tailwindcss.com/"><img src="https://tailwindcss.com/_next/static/media/tailwindcss-mark.79614a5f61617ba49a0891494521226b.svg" width="48" height="48"/></a>
</div>

**Note: this is a one-way operation. Once you `eject`, you can't go back!**
### Other Libs & Packages:

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.
- [**React Router**](https://reactrouter.com/)
- [**Framer Motion**](https://www.framer.com/motion/)
- [**qrcode.react**](https://www.npmjs.com/package/qrcode.react)
- [**react-qr-reader**](https://www.npmjs.com/package/react-qr-reader)

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.
# App's Screenshot

## Learn More

You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).

To learn React, check out the [React documentation](https://reactjs.org/).

### Code Splitting

This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting)

### Analyzing the Bundle Size

This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size)

### Making a Progressive Web App

This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app)

### Advanced Configuration

This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration)

### Deployment

This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment)

### `npm run build` fails to minify

This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)
<!-- ![Country Finder Website Screenshot](https://github.com/ahmedmohmd/country-finder/blob/main/app-screenshot.png?raw=true) -->

1 comment on commit 872fd76

@vercel
Copy link

@vercel vercel bot commented on 872fd76 Jun 26, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

qr-app – ./

qr-app-git-main-ahmedmohmd.vercel.app
qr-app-ahmedmohmd.vercel.app
qr-app-peach.vercel.app

Please sign in to comment.