Skip to content

Commit 13b98ce

Browse files
author
Nejla Şahin
authored
Update README.md
1 parent 06240ff commit 13b98ce

File tree

1 file changed

+41
-51
lines changed

1 file changed

+41
-51
lines changed

README.md

Lines changed: 41 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -1,70 +1,60 @@
1-
# Getting Started with Create React App
1+
# Punk API Project
22

3-
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
3+
This project developed using [Punk API](https://punkapi.com/documentation/v2)
44

5-
## Available Scripts
65

7-
In the project directory, you can run:
6+
- ### Project [live on](url)
87

9-
### `npm start`
8+
![Output](./docs/output.gif)
109

11-
Runs the app in the development mode.\
12-
Open [http://localhost:3000](http://localhost:3000) to view it in your browser.
10+
## Team Members
1311

14-
The page will reload when you make changes.\
15-
You may also see any lint errors in the console.
12+
| Name |
13+
| -------------------------------------------------- |
14+
| [Cansu Yarkın](https://github.com/cansuyarkin) |
15+
| [Gamze Gürcan](https://github.com/gamzegurcan) |
16+
| [Nejla Şahin](https://github.com/nejlasahin) |
1617

17-
### `npm test`
18+
----
1819

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.
20+
## Used Technologies
2121

22-
### `npm run build`
22+
- Html
23+
- Css
24+
- Bootstrap
25+
- Ant Design
26+
- React
27+
- React Debounce Input
2328

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.
29+
## Install & Run
2630

27-
The build is minified and the filenames include the hashes.\
28-
Your app is ready to be deployed!
31+
```ssh
2932
30-
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
33+
git clone https://github.com/gnc-coders/punk-api-project.git
3134
32-
### `npm run eject`
35+
$ npm install
36+
$ npm start
3337
34-
**Note: this is a one-way operation. Once you `eject`, you can't go back!**
38+
```
3539

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.
40+
## MIT License
3741

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.
42+
Copyright (c) 2022 fe-project-team
3943

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.
44+
Permission is hereby granted, free of charge, to any person obtaining a copy
45+
of this software and associated documentation files (the "Software"), to deal
46+
in the Software without restriction, including without limitation the rights
47+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
48+
copies of the Software, and to permit persons to whom the Software is
49+
furnished to do so, subject to the following conditions:
4150

42-
## Learn More
51+
The above copyright notice and this permission notice shall be included in all
52+
copies or substantial portions of the Software.
4353

44-
You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
45-
46-
To learn React, check out the [React documentation](https://reactjs.org/).
47-
48-
### Code Splitting
49-
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)
51-
52-
### Analyzing the Bundle Size
53-
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)
55-
56-
### Making a Progressive Web App
57-
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)
59-
60-
### Advanced Configuration
61-
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)
63-
64-
### Deployment
65-
66-
This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment)
67-
68-
### `npm run build` fails to minify
69-
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)
54+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
55+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
56+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
57+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
58+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
59+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
60+
SOFTWARE.

0 commit comments

Comments
 (0)