Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/sandoche/surfable-app

Install any website as an app for instant access 🖥️
https://github.com/sandoche/surfable-app

desktop-app installable installable-website pwa service-worker surfable

Last synced: 3 months ago
JSON representation

Install any website as an app for instant access 🖥️

Host: GitHub
URL: https://github.com/sandoche/surfable-app
Owner: sandoche
License: apache-2.0
Created: 2020-07-26T18:57:48.000Z (over 4 years ago)
Default Branch: master
Last Pushed: 2023-06-25T09:42:05.000Z (over 1 year ago)
Last Synced: 2024-10-12T14:06:30.698Z (3 months ago)
Topics: desktop-app, installable, installable-website, pwa, service-worker, surfable
Language: JavaScript
Homepage: https://surfable.app
Size: 152 MB
Stars: 65
Watchers: 4
Forks: 17
Open Issues: 3
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

README

Surfable

Install any website as an app for a quick access 🖥️

Surfable.app is a website to be able to install any website as an application.
It is built with `Express.js` and uses `google-play-scraper` package to search in Google Play Store and to get the metadata.

### 👉 [Get started](https://surfable.app)

## 🤔 How it works

- Surfable.app creates a Progressive Web App for each website that redirects to an URL
- It uses Google Play Store as a source of data by using apps' names, icons and developer website
- The search also works using Google Play Store data
- Because it uses the developer website as the URL of the app, some URLs can be wrong, but it can be corrected (see the documentation below)
- Some links may be missing on the search (you can make a pull request to add them)

## 📖 How to add or update a website

If you don't know Javascript, just open an [issue](https://github.com/sandoche/Surfable-app/issues) explaining what link you would like to add / edit.
Otherwise just follow the steps below.

### Update a website

If you realize that a website redirects to the wrong URL you can correct it by following these steps:
1. Search for the app name on Surfable.app
2. Copy the `appId` from the URL for example in `https://surfable.app/pwa/com.sandoche.gitnews/` it would be `com.sandoche.gitnews`
3. Edit the following file [`src/data/websites.js`](/src/data/websites.js)
4. Check if the `appId` does not already exist, if it does, edit the object and if it does not exsit, add a new object like below to the array:
```js
{
title: 'Twitter',
appId: 'com.twitter.android',
developerWebsite: 'https://twitter.com/',
icon: 'https://lh3.googleusercontent.com/wIf3HtczQDjHzHuu7vezhqNs0zXAG85F7VmP7nhsTxO3OHegrVXlqIh_DWBYi86FTIGk',
},
```
5. Note that omitting one of the fields will take the default value from Google Play. You can for example omit the icon field, and the logo will be retrieved from Google Play.
6. Then just do a pull request

### Add a website that does not exist

If a website could not be found in Google Play, it needs to be added manually.
1. Edit the following file [`src/data/websites.js`](/src/data/websites.js)
2. Check if the URL you would like to add does not exist, if it does edit the object, if it does not exist, add a new object like below to the array:
```js
{
title: 'Kanbanote',
developerWebsite: 'https://www.kanbanote.com/board',
icon: 'https://www.kanbanote.com/assets/app/images/icon_512x512.png',
appId: 'www.kanbanote.com'
},
```
3. Note that the appId can be anything except the ones that are already used on Google Play, so putting the website address is a safe choice, also the icon should have a size of 512x512
4. Then just do a pull request

## ⚙️ How to use

### Clone
```
git clone [email protected]:sandoche/Surfable-app.git
```

### Run

#### Install

```sh
npm install
```

#### Usage

```sh
npm run start
```

#### Development

```sh
npm run dev
```

### Deploy to Heroku
Since this project scraps data from Google Play, the number of queries are limited per server, therefore in case of problem we recommend you to host your own instance of Surfable.

[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy)

### Deploy using Docker
```sh
docker build . -t surfable
docker run -p 3000:80 surfable
```

## Authors

👤 **Sandoche ADITTANE & Farbod SARAF**

* Twitter: [@farbodsaraf](https://twitter.com/farbodsaraf)
* Github: [@sandoche](https://github.com/sandoche)

## 🤝 Contributing

Contributions, issues and feature requests are welcome!

## ⭐️ Show your support

Give a ⭐️ if this project helped you!

## ☕️ Buy me a coffee

If you like this project, feel free to donate: https://www.buymeacoffee.com/surfable

## 📝 License