Skip to content

Commit 610954c

Browse files
committed
update readme
1 parent 5c4444e commit 610954c

File tree

1 file changed

+50
-38
lines changed

1 file changed

+50
-38
lines changed

README.md

Lines changed: 50 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,70 +1,82 @@
1-
# Getting Started with Create React App
21

3-
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
2+
# CURRENCY CONVERTER
43

5-
## Available Scripts
4+
Website currency converter
65

7-
In the project directory, you can run:
86

9-
### `npm start`
7+
## License
108

11-
Runs the app in the development mode.\
12-
Open [http://localhost:3000](http://localhost:3000) to view it in your browser.
9+
[![MIT License](https://img.shields.io/badge/License-MIT-green.svg)](https://github.com/vinss-droid/react-currency-converter/blob/main/LICENSE)
1310

14-
The page will reload when you make changes.\
15-
You may also see any lint errors in the console.
1611

17-
### `npm test`
12+
## Demo
1813

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

22-
### `npm run build`
2316

24-
Builds the app for production to the `build` folder.\
25-
It correctly bundles React in production mode and optimizes the build for the best performance.
17+
## Tech Stack
2618

27-
The build is minified and the filenames include the hashes.\
28-
Your app is ready to be deployed!
19+
**Client:** React, Bootstrap
2920

30-
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
21+
**API:** getgeoapi.com
3122

32-
### `npm run eject`
3323

34-
**Note: this is a one-way operation. Once you `eject`, you can't go back!**
24+
## Screenshots
3525

36-
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.
26+
Home
3727

38-
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.
28+
![App Screenshot](https://raw.githubusercontent.com/vinss-droid/react-currency-converter/main/screenshots/home.png?token=GHSAT0AAAAAABX3TDVFOE3DNS2FEZC5GY7QYYRNPAA)
3929

40-
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.
30+
Converter
4131

42-
## Learn More
32+
![App Screenshot](https://raw.githubusercontent.com/vinss-droid/react-currency-converter/main/screenshots/converter.png?token=GHSAT0AAAAAABX3TDVED5RDXZIFJFYRQ2MGYYRNRUQ)
4333

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

46-
To learn React, check out the [React documentation](https://reactjs.org/).
36+
![App Screenshot](https://raw.githubusercontent.com/vinss-droid/react-currency-converter/main/screenshots/result.png?token=GHSAT0AAAAAABX3TDVFX5B5D264M3KC3YIQYYRNSQA)
4737

48-
### Code Splitting
4938

50-
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)
39+
## Run Locally
5140

52-
### Analyzing the Bundle Size
41+
Clone the project
5342

54-
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)
43+
```bash
44+
git clone https://github.com/vinss-droid/react-currency-converter.git
45+
```
5546

56-
### Making a Progressive Web App
47+
Go to the project directory
5748

58-
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)
49+
```bash
50+
cd react-currency-converter
51+
```
5952

60-
### Advanced Configuration
53+
Install dependencies
6154

62-
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)
55+
```bash
56+
npm install
57+
```
6358

64-
### Deployment
59+
Start the server
6560

66-
This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment)
61+
```bash
62+
npm start
63+
```
6764

68-
### `npm run build` fails to minify
6965

70-
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)
66+
## Environment Variables
67+
68+
To run this project, you will need to add the following environment variables to your .env file.
69+
70+
`REACT_API_KEY = YOUR_GETGEOAPI_API_KEY`
71+
72+
73+
## Authors
74+
75+
- [@vinss-droid](https://www.github.com/vinss-droid)
76+
77+
78+
## 🔗 Links
79+
[![linkedin](https://img.shields.io/badge/linkedin-0A66C2?style=for-the-badge&logo=linkedin&logoColor=white)](https://www.linkedin.com/in/kevin-sipahutar-b65381220/)
80+
81+
[![instagram](https://img.shields.io/badge/instagram-1DA1F2?style=for-the-badge&logo=instagram&logoColor=white)](https://instagram.com/sipahutarkevin)
82+

0 commit comments

Comments
 (0)