🚀 Getting Started

Basic Setup

• Clone the local-setup branch in the repository

• Install the packages using the command npm install
• Create a .env file in the root directory of the project. Add the following properties in it:

• You can obtain your Algolia Places API key here. You will get higher rate limits if you sign up and provide an api key OR it's just limited to 1000 requests/day! Moreover, code logic handles the scenario where no Algolia App ID & API key are provided since these are optional.

🧐 What's inside?

A quick look at the top-level files and directories in this weather-react project.

├── api
	├── index.js
	├── now.json
├── public
├── src
	├── components
	├──	containers
	├── context
	├── fonts
	├── sass
	├── styles
	├── tests
	├── utils
	├── App.js
	├── index.js
	├── serviceWorker.js
├── tailwind.config.js

1. api: This directory contain all of the code related to the back-end of the application.
2. public: This directory contain all the assets like images, icons, manifest (PWA), and favicons.
3. src: This directory contain all of the code related to what you see on the front-end of the application. src is a convention for “source code”.
4. tailwind.config.js: This file contains the configuration related to tailwindcss.

📖 Architecture

💻 Technologies

• This application is created with Create React App
• React (v16.12)
• Styling syntax was written in SCSS and using TailwindCSS

😢 Challenges

• First, I used the OpenWeatherMap API to fetch the weather forecast data. However, 5-day forecast data was not reliable i.e. when a user on 14th March 2020 at 7:00 PM EST tries to fetch 5-day forecast data, will get forecast data starting 15th March 2020 at 12:00 AM UTC. This posed a big problem of categorizing 5-day data into individual days since the data is not always consistent and is based on UTC and not based on the user time-zone. Finally, I switched to Dark Sky API which is more reliable and provides a robust data model. However, there is a limit of 1000 calls/day.
• Dark Sky API needs a proxy server to send and receive a response which was easy in the development stage using a browser extension like this to enable CORS in the browser. However, I can't ask every user to install this extension in their browser to check the weather forecast. So, I overcome this issue temporarily for now using the cors-anywhere library which you can get more info by checking here. However, I overcome the temporary solution and built a proxy server by deploying the Node.js  based serverless API functions on the Vercel's serverless architecture and can be accessed here.
• Latest challenge I encountered was that Teleport API temporarily got shutdown and this led to broken autocomplete city search, and photos for favorited cities. Moreover, there is a tight coupling of code logic with this API. Now, I made a well thought highly scalable solution of using Algolia Places Rest API for fetching address based on city query as well as fetching city name based on latitude and longitude. I am very much happy about this change since it removed a lot of bad code and improved the application load times and performance.
  Note: The application UI/UX is not affected with this API change.

👀 Demo

• https://iamsainikhil.com/weather-react
• API - https://weather-react-api.now.sh/
• GitHub - https://github.com/iamsainikhil/weather-react
  

🏎 Roadmap

•  Unit Testing
•  Publish this project as an NPM package that can be consumed elsewhere.
•  Add documentation for components using Storybook
  

🙌 Contribution

• Open pull request with improvements.
• If you have any new idea, check the feature request template to create a request.
• If you found any issue or a bug, check the bug report template to create a report.

📃 License

Have a look at the license file for details

📧 Contact

Whether you’d like to discuss a project, ask me about my website or simply say “hello”, I’d love to hear from you.

Email: contact@iamsainikhil.com

😍 Featured On

• React.js Examples
• Morioh