Skip to content

Commit

Permalink
docs: update readme and add project logo
Browse files Browse the repository at this point in the history
  • Loading branch information
pferreirafabricio committed Oct 9, 2023
1 parent 2a939c3 commit fe369b3
Show file tree
Hide file tree
Showing 8 changed files with 25 additions and 20 deletions.
38 changes: 21 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,18 @@
<h1 align="right">
<img src="https://ionicframework.com/img/vue/logo@2x.png" width="200px" align="left" />
<img src="public/assets/icon/logo.jpeg" width="200px" align="left" />
Ionic + Vue + Capacitor = 💖
</h1>

<p align="right">
<!-- License -->
A simple Ionic app template, using VueJS framework and Capacitor. It brings a simple folder structure and some components.
<br /><br />
<a>
<img alt="License" src="https://img.shields.io/badge/license-MIT-green?style=for-the-badge&labelColor=3880FF&color=2FBD7B">
<img alt="License" src="https://img.shields.io/badge/license-MIT-green?style=for-the-badge&labelColor=FF7F80&color=110E23">
</a>
</p>
<br>

## :eyes: Overview
## 👀 Overview

<div>
<img src="./docs/screenshots/home.png" width="auto" height="400px"/>
Expand All @@ -20,40 +21,43 @@
</div>
<br/>

> **Note**:
> Take a look in https://pferreirafabricio.github.io/ionic-vue-boilerplate for a live test. OBS: Don't forget to press F12 and toggle device emulation.
> **Note**
>
> Take a look in https://pferreirafabricio.github.io/ionic-vue-boilerplate for a live test. OBS: Don't forget to press F12 and toggle device emulation to view it in mobile view.
> **Note**:
> **Note**
>
> If you prefer you can download the .apk file in the [releases page](https://github.com/pferreirafabricio/ionic-vue-boilerplate/releases)
## :open_book: About
## 📖 About

This project is a simple Ionic app template, using VueJS framework and Capacitor. It brings a simple folder structure and some components.
This project is a boilerplate for building mobile applications using Ionic and Vue. It includes a variety of components and features, such as a login screen, a home screen, and some UI components.

## :bricks: This project was built with:
## 🧱 This project was built with:

- [Ionic](https://ionicframework.com/)
- [Ionic + Vue](https://ionicframework.com/vue)
- [Capacitor](https://capacitorjs.com/)
- [Vue](https://vuejs.org/)
- [Bootstrap Utilities for layout](https://getbootstrap.com/docs/4.0/layout/utilities-for-layout/)
- [Pinia](https://pinia.vuejs.org/)

## :running_man: Installing and Running
## 🏃🏻‍♂️ Installing and Running

1. Clone this repository `https://github.com/pferreirafabricio/ionic-vue-boilerplate.git`
2. Enter in the project's folder: `cd ionic-vue-boilerplate`
3. Run `npm install`
4. Run `npm run serve`
5. Access `http://localhost:8080` in your browser and be happy 😃
3. Run `cp .env.example .env`
4. Run `npm install`
5. Run `npm run serve` or `npm run dev`
6. Access `http://localhost:8080` in your browser and be happy 😃

## :recycle: Contribute
## Contribute

1. Fork this repository
2. Create a branch with your feature: `git checkout -b my-feature`
3. Commit your changes: `git commit -m 'feat: My new feature'`
4. Push your branch: `git push origin my-feature`

## :page_with_curl: License
## 🧾 License

This project is under the MIT license. Take a look at the [LICENSE](LICENSE) file for more details.

Expand Down
Binary file added public/assets/icon/favicon.ico
Binary file not shown.
Binary file removed public/assets/icon/favicon.png
Binary file not shown.
Binary file added public/assets/icon/logo.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified public/assets/icon/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion public/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<link
rel="shortcut icon"
type="image/png"
href="assets/icon/favicon.png"
href="assets/icon/favicon.ico"
/>

<!-- add to homescreen for ios -->
Expand Down
3 changes: 2 additions & 1 deletion src/components/Image.vue
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
<template>
<ion-img
v-bind="useAttrs()"
:src="
!imageFailsToLoad && !!src ? `${getImagesAddress}/${src}` : defaultImage
"
Expand All @@ -9,7 +10,7 @@

<script setup>
import { IonImg } from "@ionic/vue";
import { defineProps, ref, computed } from "vue";
import { defineProps, ref, computed, useAttrs } from "vue";
import { useGeneralStore } from "../store/general";
defineProps({
Expand Down
2 changes: 1 addition & 1 deletion src/pages/Login.vue
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
>
<ion-row>
<ion-col size="12">
<Image class="w-75 mb-4" src="assets/icon/logo.png" />
<Image class="mb-4" style="height: 200px" src="assets/icon/logo.png" />
</ion-col>
</ion-row>
<ion-row>
Expand Down

0 comments on commit fe369b3

Please sign in to comment.