Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/flogy/gatsby-starter-capacitor

⚡ Build blazing fast mobile apps with Gatsby and Capacitor.
https://github.com/flogy/gatsby-starter-capacitor

capacitor cordova gatsby hybrid mobile

Last synced: about 1 month ago
JSON representation

⚡ Build blazing fast mobile apps with Gatsby and Capacitor.

Host: GitHub
URL: https://github.com/flogy/gatsby-starter-capacitor
Owner: flogy
License: mit
Created: 2020-05-18T19:11:40.000Z (over 4 years ago)
Default Branch: main
Last Pushed: 2023-09-26T08:01:51.000Z (about 1 year ago)
Last Synced: 2024-08-02T05:23:32.066Z (4 months ago)
Topics: capacitor, cordova, gatsby, hybrid, mobile
Language: Swift
Homepage:
Size: 2.04 MB
Stars: 34
Watchers: 4
Forks: 4
Open Issues: 0
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

awesome-blazingly-fast - gatsby-starter-capacitor - ⚡ Build blazing fast mobile apps with Gatsby and Capacitor. (Swift)

README

![Logo](./img/gatsby-starter-capacitor.png)

**📱 Build blazing fast mobile apps with [Gatsby](https://www.gatsbyjs.com) and [Capacitor](https://capacitorjs.com)**

# gatsby-starter-capacitor

[![Pull requests are welcome!](https://img.shields.io/badge/PRs-welcome-brightgreen)](#contribute-)
[![GitHub license](https://img.shields.io/github/license/flogy/gatsby-starter-capacitor)](https://github.com/flogy/gatsby-starter-capacitor/blob/master/LICENSE)

You want to build a blazing fast web app that can also be turned into a mobile app running on Android and iOS?

Then kick off your project with this boilerplate code. This starter ships with a default configuration of Gatsby combined with Capacitor, the spiritual successor to Apache Cordova and Adobe PhoneGap.

**Need to integrate Capacitor into an existing project?** Read this article: [Build blazing fast mobile apps with Gatsby and Capacitor](https://react-freelancer.ch/blog/build-mobile-apps-using-gatsby-and-capacitor)

![Screenshots](./img/screenshots.png)

## 🚀 Quick start

1. **Create a Gatsby site.**

Use the Gatsby CLI to create a new site, specifying the gatsby-starter-capacitor.

```shell
# create a new Gatsby site using the gatsby-starter-capacitor starter
gatsby new my-gatsby-capacitor-project https://github.com/flogy/gatsby-starter-capacitor
```

1. **Start developing.**

Navigate into your new site’s directory and start it up.

```shell
cd my-gatsby-capacitor-project/
npx gatsby develop
```

1. **Open the source code and start editing!**

Your site is now running at `http://localhost:8000`!

Open the `my-hello-world-starter` directory in your code editor of choice and edit `src/pages/index.tsx`. Save your changes and the browser will update in real time!

1. **Build and start app for Android.**

Build the project and prepare it for Android (requires all dependencies installed as mentioned in the [Capacitor documentation](https://capacitor.ionicframework.com/docs/getting-started/dependencies/)).

```shell
npx gatsby build
npx cap update android
npx cap copy android
npx cap open android
```

Start your app from Android Studio which should now be opened.

After an initial start, you can use the NPM scripts `npm run build` and `npm run start:android` to restart / apply code changes.

1. **Build and start app for iOS.**

Build the project and prepare it for iOS (requires all dependencies installed as mentioned in the [Capacitor documentation](https://capacitor.ionicframework.com/docs/getting-started/dependencies/)).

```shell
npx gatsby build
npx cap update ios
npx cap copy ios
npx cap open ios
```

Start your app from Xcode which should now be opened.

After an initial start, you can use the NPM scripts `npm run build` and `npm run start:ios` to restart / apply code changes.

## Contribute 🦸

Contributions are more than welcome! I love how Gatsby helps us developers building great web apps in a short time. That's why I'd like to give back with contributions like this. If you feel the same and would like to join me in this project it would be awesome to get in touch! 😊

Please feel free to create, comment and of course solve some of the issues. To get started you can also go for the easier issues marked with the `good first issue` label if you like.

## License

The [MIT License](LICENSE)

## Credits

The _gatsby-starter-capacitor_ starter is maintained and sponsored by the Swiss web and mobile app development company [Florian Gyger Software](https://floriangyger.ch).

If this library saved you some time and money please consider [sponsoring me](https://github.com/sponsors/flogy), so I can build more libraries for free and actively maintain them for you. Thank you 🙏