Skip to content

A hybrid mobile frontend for the Quarantine help project, built using the Ionic framework. The project aims to assist people to find help while in quarantine.

License

Notifications You must be signed in to change notification settings

Quarantine-Help/quarantine-help-hybrid

Repository files navigation

QuarantineHelp

Maintainability Depfu License: GPL v3 Netlify Status Netlify Status Slack

A hybrid mobile frontend for the QuarantineHelp project. The project aims to help people to find help while in quarantine.

This repo contains the hybrid app frontend built using the Ionic Framework. The PWA version of the app can be found at https://mobile.quarantinehelp.space and an active dev version at https://mobiledev.quarantinehelp.space

Getting started

Local Development server

  • After installing up nodeJS and Ionic, you can run ng serve for a dev server.
  • Navigate to http://localhost:8100/. The app will automatically reload if you change any of the source files.
  • You could also run ionic serve --prod --ssl to test an ionic production build locally.

Build

Run ionic build to build the project. The build artifacts will be stored in the www/ directory. Use the --prod flag for a production build.

Generate icons & splash images

Run cordova-res android --skip-config --copy after installing cordova-res by running npm install -g cordova-res.

Copy your Web Assets

When you are ready to run your app natively on a device or in a simulator, copy your built web assets using npx cap copy.

Note: You may need to run npx cap sync if you wish to update the native dependencies too.

Open your Native IDE

Capacitor uses the Native IDEs to build, simulate, and run your app. To open it run npx cap open

Tip : I have added npm scripts capDev and capProd that could be used to run the above steps in a single command. So may use it like npm run capDev to build the Ionic project, sync for capacitor and open up Android Studio.

Contributing

Go through the Github issues and find something you can work on. Read the conrtibution guidelines. Ask questions and let us know before you take up something.

Do join us on Slack for the discussions.

License

This project is made available under the terms of the GPLv3. See the LICENSE file for the full text of the license.

Sponsorship


Lokalise

Lokalise supports this project and has provided us with an Enterprise Open Source plan to make the translation of this project possible ❤️

We're currently in the process of setting up Lokalise, and welcome all contributions in translating the project.

About

A hybrid mobile frontend for the Quarantine help project, built using the Ionic framework. The project aims to assist people to find help while in quarantine.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •