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

https://github.com/jsjoeio/timezoner-extension

A simple extension to help you coordinate across timezones 🕑🌏
https://github.com/jsjoeio/timezoner-extension

chrome-extension emotionjs parceljs reactjs

Last synced: 10 months ago
JSON representation

A simple extension to help you coordinate across timezones 🕑🌏

Awesome Lists containing this project

README

          

# Timezoner Extension

[![Build Status](https://travis-ci.org/jsjoeio/timezoner-extension.svg?branch=master)](https://travis-ci.org/jsjoeio/timezoner-extension)

A [Chrome extension](https://chrome.google.com/webstore/detail/timezoner/kfnfgcafkeoflpapeniggnnkcaijgbgk) to help you coordinate across timezones. Input the date and time of your event and then we give you a link where others can view the event in their respective timezone. BOOM! Timezoning made easy 👏🏼

Now [available on Firefox](https://addons.mozilla.org/en-US/firefox/addon/timezoner/) as well!

## Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

### Prerequisites

In order to get this project running locally, you'll need to have the following installed on your computer:

```Shell
node v8.11 or above
npm v5.6 or above
yarn v1.9.4 or above
```

### Installing & Developing Locally

A step by step series of examples that tell you have to get a development env running

1. Install the dependencies using yarn

```Shell
yarn install
```

2. Start the app

```Shell
yarn start
```

3. Navigate to [localhost:1234](http://localhost:1234/). You should see something like this.

![screenshot of timezoner-extension local development](http://res.cloudinary.com/dobfxs62e/image/upload/v1535315564/Timezoner-extension.png)

4. Go off and develop young one.

![happy robert redford](https://media2.giphy.com/media/xSM46ernAUN3y/giphy.gif)

## Running the tests

`npm test`

## Building

When you're ready to create a new version to deploy, run:

```Shell
yarn build
```

This preps your app for deployment. It will create a build directory called `dist`. Compress/zip this folder and upload it to the Chrome Web Store when you need to release a new update. Don't forget to change the version number in the `manifest.json`.

## Deployment

There are two ways you can deploy:

- manually by running the `deploy.js` file
- merging or pushing changes on the `master` branch

Before you do so, make sure to bump the version in the `manifest.json`. In the future, the plan is to automate the version bump.

## Built With

- [React](https://reactjs.org/) - The JavaScript framework used
- [Parcel](https://parceljs.org/) - application bundler
- [emotion](https://emotion.sh/) - styling

## Contributing

_Coming Soon_ -

## Versioning

We use [SemVer](http://semver.org/) for versioning.

## Authors

- **JavaScript Joe** - [@jsjoeio](https://github.com/jsjoeio)
- **Shawn Wang** - _Initial work_ - [@sw-yx](https://github.com/sw-yx)
He created `create-react-app-parcel` which served as a quick boilerplate for this project.

## License

This project is licensed under the MIT License - see the [LICENSE.md](https://github.com/jsjoeio/timezoner-extension/blob/master/LICENSE.md) file for details.

## Acknowledgments

- Hat tip to Shawn Wang who wrote created the boilerplate for [`create-react-app-parcel`](https://medium.freecodecamp.org/building-chrome-extensions-in-react-parcel-79d0240dd58f) and [boilerplate repo](https://github.com/sw-yx/create-react-app-parcel).