Skip to content

Commit

Permalink
Update: Donation link (#173)
Browse files Browse the repository at this point in the history
* updated dev docs

* updated package json files

* added script to serve locally

* replaced buymeacoffee with Kofi link

* updated readme links

* fix Github Actions
  • Loading branch information
nisrulz authored Jun 8, 2023
1 parent 24599c7 commit ee108f5
Show file tree
Hide file tree
Showing 9 changed files with 1,383 additions and 40 deletions.
8 changes: 1 addition & 7 deletions .github/workflows/firebase-hosting-merge.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Checkout the code
uses: actions/checkout@v2

- name: Install Node
uses: actions/setup-node@v2
with:
node-version: '14'
cache: 'npm'
uses: actions/checkout@v3

- name: Install Pug CLI
run: npm install -g pug-cli
Expand Down
12 changes: 3 additions & 9 deletions .github/workflows/firebase-hosting-pull-request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,8 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Checkout the code
uses: actions/checkout@v2

- name: Install Node
uses: actions/setup-node@v2
with:
node-version: '14'
cache: 'npm'

uses: actions/checkout@v3

- name: Install Pug CLI
run: npm install -g pug-cli

Expand All @@ -30,7 +24,7 @@ jobs:
run: |
chmod +x ./render.sh
./render.sh
- name: Firebase Deploy to Preview Channel
uses: FirebaseExtended/action-hosting-deploy@v0
with:
Expand Down
4 changes: 2 additions & 2 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
<img src="https://img.shields.io/twitter/follow/nisrulz.svg?style=social" alt="Twitter Follow">
</a>

<a href="https://www.buymeacoffee.com/nisrulz" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png" alt="Buy Me A Coffee" style="height: 41px !important;width: 174px !important;box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;-webkit-box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;" ></a>
[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/A443EQ6)

</div>

Expand Down Expand Up @@ -72,7 +72,7 @@ Please consider contributing on [GitHub sponsor](https://github.com/sponsors/nis

[![sponsoring monthly](img/sponsor_banner.png)](https://github.com/sponsors/nisrulz)

_Alternatively you can fuel my late night programming sessions by [buying me coffee :coffee:](https://www.buymeacoffee.com/nisrulz)._
_Alternatively you can fuel my late night programming sessions by [buying me coffee :coffee:](https://ko-fi.com/nisrulz)._

## Support this project

Expand Down
33 changes: 14 additions & 19 deletions dev-doc.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,17 @@
The web app uses

- [VueJs](https://vuejs.org/) - For templating and reactive updates in the DOM
- [Pug-CLI](https://github.com/pugjs/pug-cli) - To convert pug templates to html and merge partials into single [`index.html`](public/index.html) file.
- [SASS-CLI](https://sass-lang.com/documentation/cli) - To convert sass templates to css and merge partials into single [`style.css`](public/css/style.css) file.
- [js-yaml-CLI](https://github.com/nodeca/js-yaml#cli-executable) - To convert yaml templates to json and generate the [`thirdpartyservices.js`](public/js/thirdpartyservices.js) file.
- [Firebase Hosting](https://firebase.google.com/docs/hosting/) - For Hosting
- [Firebase Hosting](https://firebase.google.com/docs/hosting/) - For hosting the static web app
- CLI Tools
- [pug](https://github.com/pugjs/pug-cli) - To convert pug templates to html and merge partials into single [`index.html`](public/index.html) file.
- [sass](https://sass-lang.com/documentation/cli) - To convert sass templates to css and merge partials into single [`style.css`](public/css/style.css) file.
- [js-yaml](https://github.com/nodeca/js-yaml#cli-executable) - To convert yaml templates to json and generate the [`thirdpartyservices.js`](public/js/thirdpartyservices.js) file.
- [firebase-tools](https://github.com/firebase/firebase-tools) - To interact with Firebase as a service from command line.
---
> Install the CLI tools using
>
> ```npm install -g pug-cli sass js-yaml firebase-tools```

If you wish to modify the code for the webapp, then look into [`src`](src) directory.

Expand All @@ -29,11 +36,11 @@ To compile the code under `src` folder, simply execute the helper bash script [`

This will generate the `index.html`, `style.css` and `thirdpartyservices.js` files at their required directory path.

Open `index.html` to view the full webapp 🎉
Open `index.html` to view the full web app 🎉

## Contributing more 3rd Party Service's links

The webapp uses a JSON array to populate the list of 3rd party services section. This JSON array is generated from another yaml file.
The web app uses a JSON array to populate the list of 3rd party services section. This JSON array is generated from another yaml file.

If you want contribute a new 3rd party service for the section then open a Pull Request which simply adds a new item in the YAML file [`src/includes/yaml/thirdpartyservices.yml`](src/includes/yaml/thirdpartyservices.yml)

Expand All @@ -53,19 +60,7 @@ The format is very simple and you only need to provide the below fields:

Additionally, you also will have to drop the logo image into the [`public/images/third_party_logos/`](public/images/third_party_logos/) folder. Make sure the logo is **160 × 160** in size.

### Deployment

In order to deploy with the web app and Firebase hosting you would need to setup Firebase CLI.

### Setup Firebase CLI

The instructions to set it up differ based on the operating system, which is explained [here](https://firebase.google.com/docs/cli).

However you can also use the below command to setup/update the Firebase CLI, which will take care of everything (including detecting the OS you are running):

```bash
curl -sL firebase.tools | bash
```
## Deployment

### Server and test locally

Expand Down
Loading

0 comments on commit ee108f5

Please sign in to comment.