Weathernook

This is a weather app built using Vite, React, TypeScript, Tanstack Router, Tanstack Query, and tested with Vitest and Fast Check.

Table of Contents

• Getting Started
  • Prerequisites
  • Installation
• Usage
• Testing
• Deployment
• Built With
• Contributing
• License
• Acknowledgments

Getting Started

Prerequisites

Before you begin, ensure you have met the following requirements:

• Node.js: Make sure you have Node.js installed on your machine.

Installation

1. Clone the repository:

   gh repo clone LRNZ09/weathernook

2. Change to the project directory:

   cd weathernook

3. Install the project dependencies:

   npm install

Usage

To run the Weathernook app locally, use the following command:

npm run dev

This will start the development server, and you can access the app in your web browser at http://localhost:5173.

Testing

We use Vitest and Fast Check for testing. To run the tests, use the following command:

npm run test

Deployment

To deploy the Weathernook app, you can use your preferred hosting service. You may need to configure environment variables for API keys and other sensitive information if applicable.

Built With

• Vite - Fast development server and build tool.
• React - A JavaScript library for building user interfaces.
• TypeScript - A statically typed superset of JavaScript.
• Tanstack Router - Declarative routing for React.
• Tanstack Query - Data fetching and state management for React.
• Ahooks - A high-quality & reliable React Hooks library.
• Jotai - Primitive and flexible state management for React.
• Zod - TypeScript-first schema validation with static type inference.
• Vitest - Test runner for modern JavaScript projects.
• Fast Check - A property-based testing library for JavaScript and TypeScript.

Contributing

Contributions are welcome! Please feel free to open issues or pull requests.

License

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

Acknowledgments

• Thanks to the creators and maintainers of the technologies used in this project.
• Weather data provided by OpenWeather.