diff --git a/README.md b/README.md index 0f82abf..a9f631f 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,29 @@ -# noblePrize +# nobelPrize +is a dynamic web application designed to retrieve data about Nobel laureates from the years 1901-1905. The application fetches the data dynamically from the [NobelAPI](https://api.nobelprize.org/2.1/nobelPrizes) based on the selected year. This project served as an introduction to `TypeScript` for me, while also allowing me to deepen my understanding of `React Router` and `React Query`. Additionally, the project was an opportunity to explore and test the capabilities of the `MaterialUI` library. -task: + + +## Installation + +You can install application locally via npm & vite, or watch how it works [HERE](https://majkeloess.github.io/nobelPrize/). +```bash +git clone https://github.com/majkeloess/nobelPrize && cd nobelPrize && npm i && npm run dev +``` + +## Dependencies +- React +- ReactDOM +- Vite +- MUI +- React Router +- React Query + +## Photos +![image](https://github.com/majkeloess/nobelPrize/assets/118011581/0f7a5435-4ebc-47f1-9ef8-6cc1f877315a) +![image](https://github.com/majkeloess/nobelPrize/assets/118011581/f3d724e5-9f0f-4951-bf60-9789d572a655) + + + +## License + +[MIT](https://choosealicense.com/licenses/mit/)