Skip to content

Srivarshan-T/SkySync

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 

Repository files navigation

SkySync

SkySync is a weather app that provides real-time weather updates and forecasts through a sleek, user-friendly interface. Built with React and Vite, SkySync offers fast performance and an intuitive design for checking weather conditions on the go.

Project Overview

SkySync pulls weather data from a third-party API to display current conditions, hourly forecasts, and daily summaries. The app is designed to be responsive, making it perfect for mobile and desktop devices.

Key Features

  • Real-time weather data and forecasts.
  • Interactive user interface.
  • Responsive design for mobile and desktop devices.
  • Geolocation support to automatically detect the user's location.

Live Demo

Check out the live version of SkySync hosted on Firebase:
SkySync Live Demo

Installation Process

Follow these steps to set up SkySync locally:

Step 1: Create a New Vite App

  1. Install Vite (if you don’t have it yet):

    npm create vite@latest skysync --template react

    This will set up a new Vite project named skysync with a React template.

  2. Navigate to the project directory:

    cd skysync
  3. Install dependencies:

    npm install

Step 2: Replace the src and public Folders

  1. Delete the existing src/ and public/ folders in the newly created Vite project:

    rm -rf src/ public/
  2. Copy the src/ and public/ folders from the SkySync repository and paste them into the skysync project directory.

Step 3: Install Missing Dependencies

If your SkySync app uses additional libraries or dependencies, you’ll need to install them. Check your src/ files for any external libraries, and install them:

For example:

npm install react-router-dom axios

Step 4: Update the .env File (if applicable)

If your SkySync app uses any environment variables (such as an API key for weather data), create a .env file in the root directory and add the necessary variables:

Example .env file:

VITE_WEATHER_API_KEY=your-api-key

Step 5: Run the Development Server

  1. Start the development server:

    npm run dev
  2. Open your browser and visit http://localhost:5173 to view the app running locally.

Project Structure

After following these steps, your project directory should look like this:

skysync/
├── public/
│   └── index.html
├── src/
│   ├── App.jsx
│   ├── components/
│   ├── styles/
│   └── api/
├── .env (optional)
├── package.json
├── vite.config.js
└── node_modules/

Contributing

Contributions are welcome! Please fork the repository, create a new branch, and submit a pull request.

How to Contribute:

  1. Fork the repository.
  2. Create a new branch:
    git checkout -b feature-branch-name
  3. Commit your changes:
    git commit -m "Description of changes"
  4. Push your branch:
    git push origin feature-branch-name
  5. Open a pull request.

License

This project is licensed under the MIT License.


---

### Key Sections:
1. **Live Demo**: Link to your Firebase-hosted demo.
2. **Installation Process**: Clear instructions to set up the project locally from the uploaded `src/` and `public/` folders.
3. **License**: Added an MIT license section to clarify that the project is open-source (you can change this to another license if necessary).
4. **Contributing**: Instructions for others to contribute to the project.

 

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published