Skip to content

arcetros/neulan

Repository files navigation

View Demo | Report Bug | Request Feature

About the project

Neulan is a weather forecast application developed in typescript using React. The app allows you to search weather data from your current location or any other specific locations around the globe using OpenWeatherMap API

Built with

  • TypeScript
  • React
  • Redux
  • TailwindCSS

🚩 Features

  • City weather, preferably current location (using geolocation or browser ip if location permission not granted)
  • Search by city
  • Forecast by today and for the week
  • Message recommendations based on current weather condition
  • Detailed conditions for weather (e.g:., wind speed, rain chance, etc)
  • Lifting state up to the url
  • Convertable units of measurement (metric & imperial)
  • Light Mode / Dark Mode
  • .. More 🙄 ?

Getting Started

To clone and run this application, you'll need Git and Node.js (which comes with npm) installed on your computer. From your command line:

# Clone this repository
$ git clone https://github.com/arcetros/neulan

# Go into the repository
$ cd neulan

# Install dependencies for the frontend and run the server
$ npm install

Setup

Create a file called .env in the root of the Neulan project. Add the following code in the file.

REACT_APP_CITY_API= <insert here>

Neulan is using Geo location, Onecall and Daily API from OpenWeatherMap. to be able to access their API you need to have an account and API Key which u can get it from here here.

Run the application

You can now start the application if you followed the instruction 🥳🎉

npm run dev

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE.txt for more information

Acknowledgments