Merge branch 'main' of https://github.com/forgeManNation/map

README.md

@@ -1,46 +1,14 @@
-# Getting Started with Create React App
+# Map of intergovernmental organisations
 
-This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
-
-## Available Scripts
-
-In the project directory, you can run:
-
-### `npm start`
-
-Runs the app in the development mode.\
-Open [http://localhost:3000](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](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
-
-### `npm run build`
+## About
+Intergovernmental organisations map or IGO map for short,
+is an interactive application where you can select any of around 250 different international
+organisations which were data-scraped from [World Fact Book](https://www.cia.gov/the-world-factbook/) using python into a [JSON file](https://github.com/forgeManNation/map/blob/a94a262f0891681e9198abf3c95a37240c06052f/src/data/IGOs.json), which now functions as a user-side database.
+Additional data about all of the countries were downloaded from a public source and can be found in another [JSON file](https://github.com/forgeManNation/map/blob/a94a262f0891681e9198abf3c95a37240c06052f/src/data/world_countries_information.json).
+In next versions of this app the information and most importantly the flag of each country will be stored server-side to prevent long loading times. Additional data about each organisation are fetched from wikipedia and loaded asynchronously. 
 
-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!
+## Technology used
+Aplication uses React, Leaflet Tailwind and Typescript.
 
-See the section about [deployment](https://facebook.github.io/create-react-app/docs/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.
-
-## 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/).
+This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).