Skip to content

Latest commit

 

History

History
61 lines (42 loc) · 1.95 KB

README.md

File metadata and controls

61 lines (42 loc) · 1.95 KB

PluggedIn.cafe

PluggedIn.cafe is a project aimed at helping digital nomads and freelancers find coffee shops with available electric sockets for their devices. It's a global map of cafes that cater to the needs of remote workers, where users can view and contribute information about cafes in their area.

Table of Contents

  1. How It Works
  2. Contributing
  3. Installation
  4. License

How It Works

PluggedIn.cafe uses a Google Maps integration to show the locations of coffee shops that provide electric sockets. Users can view the map and find places in their area (or any location) that offer these amenities.

Contributing

We welcome contributions! You can help by adding coffee shops from your area to our database. Follow the steps below to contribute:

How to Add a Coffee Shop:

  1. Fork this repository.

  2. Clone your fork to your local machine:

    git clone https://github.com/your-username/PluggedIn.cafe.git

  3. Open the coffeeshops.json file and add the details of the coffee shop:

    • Name: The name of the coffee shop.
    • Latitude & Longitude: The geographical coordinates.
    • Number of Sockets: How many sockets are available.
    • Wi-Fi: Does the shop offer Wi-Fi? (Yes or No)

  4. Commit your changes:

    git add coffeeshops.json
git commit -m "Add <Cafe Name> in <City/Country>"

  5. Push the changes to your forked repository:

     git push origin main

  6. Create a pull request to merge your changes into the main repository.

Installation

If you'd like to run this project locally, follow these steps:

  1. Clone this repository. 
    git clone https://github.com/clariceism/PluggedIn.cafe.git
  2. Open the folder in your code editor and open index.html to view the map.

License

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