An open API service indexing awesome lists of open source software.

https://github.com/rajat19/wander-weather

World map showcasing weather
https://github.com/rajat19/wander-weather

d3 firebase react tailwind typescript vite world-map

Last synced: 9 months ago
JSON representation

World map showcasing weather

Awesome Lists containing this project

README

          

# Welcome to Wander Weather

## Project Info

The website was designed over [Lovable](https://lovable.dev) and then modified locally

Provides user a world map that showcases each month and the temperature, rainfall and best time to visit a particular country so that user can take a decision before planning any trip

_Note: The map used might not be 100% correct as rendered via libraries. Don't sue me if you find country of your map not correct_

## What technologies are used for this project?

This project is built with:

- Vite
- TypeScript
- React
- Tailwind CSS
- Firebase

## Getting Started

### Prerequisites

- Node.js 18+ and npm 9+

### Installation

```bash
npm install
```

### Development

```bash
npm run dev
```

Vite will print a local URL in the terminal to open the app.

### Build

```bash
npm run build
```

### Preview (after build)

```bash
npm run preview
```

### Deploy (GitHub Pages)

```bash
npm run deploy
```

## Available Scripts

- `dev`: Start the Vite dev server
- `build`: Production build
- `build:dev`: Development-mode build
- `preview`: Preview the production build locally
- `lint`: Run ESLint
- `deploy`: Publish `dist/` to GitHub Pages

## Contributing

Contributions are welcome! To get started:

1. Fork the repository and create your feature branch:
```bash
git checkout -b feat/your-feature
```
2. Install dependencies and run the dev server:
```bash
npm install
npm run dev
```
3. Make your changes, keeping code clear and typed. Prefer descriptive names and early returns.
4. Run linting and ensure the app builds:
```bash
npm run lint
npm run build
```
5. Commit using meaningful messages and open a Pull Request against `main`.

Guidelines:
- Keep components small and focused.
- Avoid deep nesting; handle edge cases early.
- Match existing formatting and Tailwind conventions.
- Include types for public APIs and props.

## License

This project is licensed under the MIT License — see the `LICENSE` file for details.