Skip to content

stefanros481/my-yr-app

Repository files navigation

Car Trip Weather App

A React application for planning car trips with weather forecasts along the route. Users can input starting and destination points, view routes on an interactive map, and see weather conditions along their journey.

🚀 Getting Started

Prerequisites

  • Node.js (v18 or higher)
  • npm or yarn

Installation

  1. Clone the repository:
git clone https://github.com/stefanros481/my-yr-app.git
cd my-yr-app
  1. Install dependencies:
npm install
  1. Start the development server:
npm run dev
  1. Open your browser and navigate to http://localhost:5173

🛠️ Tech Stack

  • Frontend: React 19 with TypeScript
  • Build Tool: Vite
  • Styling: Tailwind CSS (to be added)
  • UI Components: shadcn/ui (to be added)
  • Maps: Google Maps API or Mapbox (to be added)
  • Weather: yr.no API (to be added)

📁 Project Structure

src/
├── components/
│   ├── ui/              # shadcn/ui components
│   ├── map/             # Map-related components
│   ├── trip/            # Trip planning components
│   ├── weather/         # Weather display components
│   └── layout/          # Layout components
├── hooks/               # Custom React hooks
├── services/
│   ├── api/            # API integration services
│   └── utils/          # Utility functions
├── types/              # TypeScript type definitions
└── store/              # State management

🎯 Development Status

Currently in Phase 1: Basic Setup

See Milestone Plan for detailed progress tracking.

📚 Documentation

🤝 Contributing

This is a personal project, but contributions are welcome! Please read the specification documents before contributing.

📄 License

This project is private and not currently licensed for public use.

You can also install eslint-plugin-react-x and eslint-plugin-react-dom for React-specific lint rules:

// eslint.config.js
import reactX from 'eslint-plugin-react-x'
import reactDom from 'eslint-plugin-react-dom'

export default tseslint.config([
  globalIgnores(['dist']),
  {
    files: ['**/*.{ts,tsx}'],
    extends: [
      // Other configs...
      // Enable lint rules for React
      reactX.configs['recommended-typescript'],
      // Enable lint rules for React DOM
      reactDom.configs.recommended,
    ],
    languageOptions: {
      parserOptions: {
        project: ['./tsconfig.node.json', './tsconfig.app.json'],
        tsconfigRootDir: import.meta.dirname,
      },
      // other options...
    },
  },
])

About

Simple travel and weather app powered by yr.no

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors