diff --git a/README.md b/README.md index 58beeac..f308b95 100644 --- a/README.md +++ b/README.md @@ -1,70 +1,49 @@ -# Getting Started with Create React App +
screenshot
-This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). -## Available Scripts +# 🌊 WAVES -In the project directory, you can run: +Waves permite conocer si las condiciones son ideales para surfear 🏄, así como los datos meteorológicos actuales de tu posición y el pronóstico semanal. -### `npm start` +Puedes probarla [clickando aquí](https://bryanpf93.github.io/practica-3-weather/) -Runs the app in the development mode.\ -Open [http://localhost:3000](http://localhost:3000) to view it in your browser. +Creada por cuatro estudiantes de UX/UI y tres de Web Development de [NEOLAND](https://www.neoland.es), a fin de practicar nuevos conocimientos y afianzar los ya adquiridos. -The page will reload when you make changes.\ -You may 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. +## 🚀 Technologías -### `npm run build` +Este proyecto fue desarrollado utilizando las siguientes tecnologías: -Builds the app for production to the `build` folder.\ -It correctly bundles React in production mode and optimizes the build for the best performance. +- [Figma ](https://www.figma.com/) -The build is minified and the filenames include the hashes.\ -Your app is ready to be deployed! +- CSS, HTML, Bootstrap + +- [React – A JavaScript library for building user interfaces (reactjs.org)](https://reactjs.org/) +- [React Leaflet - React components for Leaflet maps](https://react-leaflet.js.org/) -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!** +## ✨ USO -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. +* Clona el repositorio. +* Cambia al directorio del repositorio clonado. +* Instala dependencias con `npm install` +* Crea un archivo `.env' y agrea las API KEYS de Openweathermap y Stormglass + + REACT_APP_API_KEY= + REACT_APP_STORMGLASS_KEY= + +* Inicia el servidor de desarrollo con `npm start`. +* Dirígete a [http://localhost:3000](http://localhost:3000) para ver el proyecto en tu navegador. -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 +## 📝 Descripción APIs -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/). +Esta aplicación utiliza dos APIs, una para las condiciones meteorológicas específicas para la práctica del surf y otra para las genéricas. -### Code Splitting +- [Openweathermap ](https://openweathermap.org/) (1000 llamadas al día gratuitas.) +- [Stormglass ](https://stormglass.io/) (10 llamadas al día gratuitas). -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)