Domicilio Boilerplate

If you want to make the same proj for your city, the only thing I ask is to fork the main repo to make it yours. Thanks!

Fetaures

⚛️ PWA 📵 Offline Ready 0️⃣ Zero-config

Quick Start

# install dependencies
npm install

# serve with hot reload at localhost:8080
npm run dev

# build for production with minification
npm run build

# test the production build locally
npm run serve

How to

1. Change the specific label related to me and my city are inside the .env file, if you change that the js will be clean ;)
2. Change the hardocded name of the city in the assets/sitemap.xml file
3. Change the hardocded name of the city in the assets/robots.txt file
4. Change the name and short_name inside manifest.json
5. Change the name inside package.json

Data source

All the data are fetched from this gist: https://gist.githubusercontent.com/tomma5o/1ca63d091b01a2fa6a73a17cc86b8fe6/raw/FerraraDomicilio.json

When you add your gist url remember to delete the last hash because points directly to a specific commit, otherwise you would get an outdated version, so for example:

remove the second hash ------------------------------------┐
                                                         
https://gist.githubusercontent.com/tomma5o/<hash>/raw/<removeThisHash>/FerraraDomicilio.json

Netlify deploy & configuration

The site is developed with some specific https://netlify.com APIs.

Deploy configuration steps

1. Connect your GitHub account to Netlify
2. Select the project
3. In Settings → Build & Deploy → Set Build command to : npm run build
4. In Settings → Build & Deploy → Set Publish directory to : build

Google analytics setup

In Settings → Build & Deploy → Post processing → Snippet injection: you can add here your GAnalytics snippet

Contact Form

In Form you can find all the submissions.
There are two type of submission: Verified Submission and Spam Submission sometimes they end up in spam

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Tommaso Poletti 💬 💻 🎨 📖 🤔 🚧

Andrea Verlicchi 💬 💻 📖 🤔

Lorenzo Camporesi 💻 🤔

Davide Mandelli 🐛 💻

Christian Varisco 💻 🤔

This project follows the all-contributors specification. Contributions of any kind welcome!

Support this project

If this project has helped you in any way, a small contribution is welcome! I can't guarantee it will be a coffee though 🍺