responsively-app/README.md

97 lines
8.8 KiB
Markdown
Raw Normal View History

2020-06-09 08:54:39 +00:00
# Responsively App [![Twitter Follow](https://img.shields.io/twitter/follow/ResponsivelyApp?style=social)](https://twitter.com/ResponsivelyApp)
2020-05-29 11:00:24 +00:00
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
2020-06-23 14:07:42 +00:00
[![All Contributors](https://img.shields.io/badge/all_contributors-15-orange.svg?style=flat-square)](#contributors-)
2020-05-29 11:00:24 +00:00
<!-- ALL-CONTRIBUTORS-BADGE:END -->
2020-06-12 15:58:31 +00:00
[![Gitter chat](https://img.shields.io/gitter/room/badges/shields.svg)](https://gitter.im/responsively-app) [![xscode](https://img.shields.io/badge/Available%20on-xs%3Acode-blue?style=?style=plastic&logo=appveyor&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEAAAABACAMAAACdt4HsAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAAZQTFRF////////VXz1bAAAAAJ0Uk5T/wDltzBKAAAAlUlEQVR42uzXSwqAMAwE0Mn9L+3Ggtgkk35QwcnSJo9S+yGwM9DCooCbgn4YrJ4CIPUcQF7/XSBbx2TEz4sAZ2q1RAECBAiYBlCtvwN+KiYAlG7UDGj59MViT9hOwEqAhYCtAsUZvL6I6W8c2wcbd+LIWSCHSTeSAAECngN4xxIDSK9f4B9t377Wd7H5Nt7/Xz8eAgwAvesLRjYYPuUAAAAASUVORK5CYII=)](https://xscode.com/manojvivek/responsively-app) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://github.com/manojVivek/responsively-app/issues)
2020-06-09 08:02:37 +00:00
2020-05-17 09:21:42 +00:00
[![PH](https://api.producthunt.com/widgets/embed-image/v1/top-post-badge.svg?post_id=200375&theme=light&period=daily)](https://www.producthunt.com/posts/responsively?utm_source=badge-top-post-badge&utm_medium=badge&utm_souce=badge-responsively)
2020-06-05 04:03:45 +00:00
Website: https://responsively.app
2020-05-17 09:21:42 +00:00
2020-03-18 14:15:59 +00:00
A modified browser built using [Electron](https://www.electronjs.org/) that helps in responsive web development.
2020-06-05 04:03:45 +00:00
![Quick Demo](https://responsively.app/assets/img/responsively-app.gif)
2020-03-18 14:15:59 +00:00
2020-03-18 15:39:10 +00:00
## Features
2020-03-18 15:46:35 +00:00
1. Mirrored User-interactions across all devices.
2. Customizable preview layout to suit all your needs.
3. One handy elements inspector for all devices in preview.
4. 30+ built-in device profiles with option to add custom devices.
5. One-click screenshot all your devices.
6. Hot reloading supported for developers.
2020-06-05 04:03:45 +00:00
Please visit the website to know more about the application - https://responsively.app
2020-03-18 14:15:59 +00:00
2020-05-22 21:36:49 +00:00
2020-05-23 05:45:10 +00:00
## Download
The application is available for Mac, Windows and Linux platforms. Please download it from here - https://github.com/manojVivek/responsively-app/releases
Alternatively, MacOS users can use brew to install it:
2020-05-22 21:36:49 +00:00
```bash
brew cask install responsively
```
2020-06-09 08:54:39 +00:00
Follow on Twitter for future updates - [![Twitter Follow](https://img.shields.io/twitter/follow/ResponsivelyApp?style=social)](https://twitter.com/ResponsivelyApp)
2020-05-22 18:08:47 +00:00
2020-03-18 15:46:35 +00:00
## Issues
If you face any problems while using the application, please open an issue here - https://github.com/manojVivek/responsively-app/issues
2020-03-18 14:15:59 +00:00
2020-06-13 13:46:41 +00:00
## Roadmap
2020-06-16 09:41:50 +00:00
Here is the roadmap of the desktop app - https://github.com/manojVivek/responsively-app/projects/12?fullscreen=true.
2020-06-13 13:46:41 +00:00
2020-03-18 15:46:35 +00:00
## Contribute
2020-03-18 15:39:10 +00:00
1. Goto `desktop-app` folder
2020-05-17 09:14:36 +00:00
2. Run `yarn dev`. This will start the app for local development with live reloading.
2020-03-18 14:15:59 +00:00
2020-03-18 15:39:10 +00:00
## Distribution
You can build the app for distrbution by runing:
```yarn package-all```
This will build the binaries for all the platforms and place it in the `releases` folder.
2020-03-18 14:15:59 +00:00
2020-03-18 15:39:10 +00:00
If you want to build the binary for a specific platform, run one of the following commands:
2020-03-18 14:15:59 +00:00
2020-03-18 15:39:10 +00:00
**Mac** - ```yarn package-mac```
**Windows(NSIS)** - ```yarn package-win```
2020-03-18 14:15:59 +00:00
2020-03-18 15:39:10 +00:00
**Linux(AppImage)** - ```yarn package-linux```
2020-05-29 11:00:24 +00:00
## Contributors ✨
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<table>
<tr>
2020-06-20 12:49:51 +00:00
<td align="center"><a href="http://twitter.com/vivek_jonam"><img src="https://avatars1.githubusercontent.com/u/1283424?v=4" width="100px;" alt=""/><br /><sub><b>Manoj Vivek</b></sub></a><br /><a href="https://github.com/manojVivek/responsively-app/commits?author=manojVivek" title="Code">💻</a> <a href="https://github.com/manojVivek/responsively-app/commits?author=manojVivek" title="Tests">⚠️</a> <a href="#projectManagement-manojVivek" title="Project Management">📆</a></td>
<td align="center"><a href="https://github.com/esprush"><img src="https://avatars0.githubusercontent.com/u/26249498?v=4" width="100px;" alt=""/><br /><sub><b>Suresh P</b></sub></a><br /><a href="https://github.com/manojVivek/responsively-app/commits?author=esprush" title="Code">💻</a> <a href="https://github.com/manojVivek/responsively-app/commits?author=esprush" title="Tests">⚠️</a> <a href="#projectManagement-esprush" title="Project Management">📆</a></td>
2020-05-29 11:07:35 +00:00
<td align="center"><a href="https://github.com/sprabowo"><img src="https://avatars2.githubusercontent.com/u/11748183?v=4" width="100px;" alt=""/><br /><sub><b>Sigit Prabowo</b></sub></a><br /><a href="https://github.com/manojVivek/responsively-app/commits?author=sprabowo" title="Code">💻</a></td>
2020-05-29 11:09:17 +00:00
<td align="center"><a href="https://github.com/leon0707"><img src="https://avatars1.githubusercontent.com/u/523684?v=4" width="100px;" alt=""/><br /><sub><b>Leon Feng</b></sub></a><br /><a href="https://github.com/manojVivek/responsively-app/commits?author=leon0707" title="Documentation">📖</a></td>
2020-05-29 11:23:36 +00:00
<td align="center"><a href="https://github.com/kishoreio"><img src="https://avatars2.githubusercontent.com/u/30261988?v=4" width="100px;" alt=""/><br /><sub><b>Kishore S</b></sub></a><br /><a href="https://github.com/manojVivek/responsively-app/commits?author=kishoreio" title="Code">💻</a></td>
2020-06-04 14:21:18 +00:00
<td align="center"><a href="https://jjavierdguezas.github.io"><img src="https://avatars2.githubusercontent.com/u/13673443?v=4" width="100px;" alt=""/><br /><sub><b>José Javier Rodríguez Zas</b></sub></a><br /><a href="https://github.com/manojVivek/responsively-app/commits?author=jjavierdguezas" title="Code">💻</a> <a href="https://github.com/manojVivek/responsively-app/commits?author=jjavierdguezas" title="Tests">⚠️</a></td>
2020-05-31 14:42:13 +00:00
<td align="center"><a href="https://github.com/romanakash"><img src="https://avatars1.githubusercontent.com/u/40427975?v=4" width="100px;" alt=""/><br /><sub><b>Roman Akash</b></sub></a><br /><a href="https://github.com/manojVivek/responsively-app/commits?author=romanakash" title="Code">💻</a></td>
2020-05-29 11:00:24 +00:00
</tr>
2020-06-09 10:57:27 +00:00
<tr>
<td align="center"><a href="https://github.com/RomainFrancony"><img src="https://avatars3.githubusercontent.com/u/22396965?v=4" width="100px;" alt=""/><br /><sub><b>Romain Francony</b></sub></a><br /><a href="https://github.com/manojVivek/responsively-app/commits?author=RomainFrancony" title="Code">💻</a></td>
2020-06-10 03:19:09 +00:00
<td align="center"><a href="https://github.com/AARYAN-MAHENDRA"><img src="https://avatars1.githubusercontent.com/u/64866670?v=4" width="100px;" alt=""/><br /><sub><b>AARYAN-MAHENDRA</b></sub></a><br /><a href="https://github.com/manojVivek/responsively-app/commits?author=AARYAN-MAHENDRA" title="Code">💻</a></td>
2020-06-10 03:20:47 +00:00
<td align="center"><a href="https://github.com/Nothing-Works"><img src="https://avatars3.githubusercontent.com/u/18606648?v=4" width="100px;" alt=""/><br /><sub><b>Andy</b></sub></a><br /><a href="https://github.com/manojVivek/responsively-app/commits?author=Nothing-Works" title="Code">💻</a></td>
2020-06-17 15:27:34 +00:00
<td align="center"><a href="https://github.com/Kidcredo"><img src="https://avatars0.githubusercontent.com/u/15522605?v=4" width="100px;" alt=""/><br /><sub><b>Ryan Pais</b></sub></a><br /><a href="https://github.com/manojVivek/responsively-app/commits?author=Kidcredo" title="Code">💻</a> <a href="https://github.com/manojVivek/responsively-app/commits?author=Kidcredo" title="Tests">⚠️</a></td>
2020-06-19 08:11:00 +00:00
<td align="center"><a href="https://grafikart.fr"><img src="https://avatars1.githubusercontent.com/u/395137?v=4" width="100px;" alt=""/><br /><sub><b>Jonathan</b></sub></a><br /><a href="https://github.com/manojVivek/responsively-app/commits?author=Grafikart" title="Code">💻</a></td>
2020-06-19 08:16:32 +00:00
<td align="center"><a href="https://github.com/heygema"><img src="https://avatars1.githubusercontent.com/u/10743728?v=4" width="100px;" alt=""/><br /><sub><b>Gema Anggada ✌︎</b></sub></a><br /><a href="https://github.com/manojVivek/responsively-app/commits?author=heygema" title="Code">💻</a></td>
2020-06-23 10:02:14 +00:00
<td align="center"><a href="https://github.com/jonathanurias96"><img src="https://avatars2.githubusercontent.com/u/57416786?v=4" width="100px;" alt=""/><br /><sub><b>jonathanurias96</b></sub></a><br /><a href="https://github.com/manojVivek/responsively-app/commits?author=jonathanurias96" title="Code">💻</a></td>
2020-06-09 10:57:27 +00:00
</tr>
2020-06-23 14:07:42 +00:00
<tr>
<td align="center"><a href="https://falecci.dev"><img src="https://avatars2.githubusercontent.com/u/17703824?v=4" width="100px;" alt=""/><br /><sub><b>Federico Alecci</b></sub></a><br /><a href="https://github.com/manojVivek/responsively-app/commits?author=falecci" title="Code">💻</a></td>
</tr>
2020-05-29 11:00:24 +00:00
</table>
<!-- markdownlint-enable -->
<!-- prettier-ignore-end -->
<!-- ALL-CONTRIBUTORS-LIST:END -->
2020-05-29 11:23:36 +00:00
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!