Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tobistudio/fast-api
https://github.com/tobistudio/fast-api
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/tobistudio/fast-api
- Owner: tobistudio
- Created: 2023-12-18T17:24:55.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2023-12-18T17:31:57.000Z (about 1 year ago)
- Last Synced: 2024-10-12T09:49:59.532Z (2 months ago)
- Language: Vue
- Size: 26.4 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# BioReveal
## Framework7 CLI Options
Framework7 app created with following options:
```
{
"cwd": "C:\\Users\\Doug\\Desktop\\Gender",
"type": [
"web",
"pwa",
"capacitor"
],
"name": "BioReveal",
"pkg": "com.cwdgservices.bioreveal",
"framework": "vue",
"template": "single-view",
"cssPreProcessor": false,
"bundler": "vite",
"capacitor": {
"platforms": [
"ios",
"android"
]
},
"theming": {
"customColor": false,
"color": "#007aff",
"darkMode": false,
"iconFonts": true
},
"customBuild": false
}
```
## Install Dependencies
First of all we need to install dependencies, run in terminal
```
npm install
```
## NPM Scripts
* 🔥 `start` - run development server
* 🔧 `dev` - run development server
* 🔧 `build` - build web app for production
* 📱 `build-capacitor-ios` - build app and copy it to iOS capacitor project
* 📱 `build-capacitor-android` - build app and copy it to Android capacitor project
## Vite
There is a [Vite](https://vitejs.dev) bundler setup. It compiles and bundles all "front-end" resources. You should work only with files located in `/src` folder. Vite config located in `vite.config.js`.
## PWA
This is a PWA. Don't forget to check what is inside of your `service-worker.js`. It is also recommended that you disable service worker (or enable "Update on reload") in browser dev tools during development.
## Capacitor
This project created with Capacitor support. And first thing required before start is to add capacitor platforms, run in terminal:
```
npx cap add ios && npx cap add android
```
Check out [official Capacitor documentation](https://capacitorjs.com) for more examples and usage examples.
## Assets
Assets (icons, splash screens) source images located in `assets-src` folder. To generate your own icons and splash screen images, you will need to replace all assets in this directory with your own images (pay attention to image size and format), and run the following command in the project directory:
```
framework7 assets
```
Or launch UI where you will be able to change icons and splash screens:
```
framework7 assets --ui
```
## Capacitor Assets
Capacitor assets are located in `resources` folder which is intended to be used with `cordova-res` tool. To generate mobile apps assets run in terminal:
```
npx cordova-res
```
Check out [official cordova-res documentation](https://github.com/ionic-team/cordova-res) for more usage examples.
## Documentation & Resources
* [Framework7 Core Documentation](https://framework7.io/docs/)
* [Framework7 Vue Documentation](https://framework7.io/vue/)
* [Framework7 Icons Reference](https://framework7.io/icons/)
* [Community Forum](https://forum.framework7.io)
## Support Framework7
Love Framework7? Support project by donating or pledging on:
- Patreon: https://patreon.com/framework7
- OpenCollective: https://opencollective.com/framework7