Skip to content

Latest commit

 

History

History
213 lines (156 loc) · 27.7 KB

README.md

File metadata and controls

213 lines (156 loc) · 27.7 KB

Warga Bantu Warga

All Contributors

codecov CI Deploy Web Perf Check

A society initiative to circulate information about health facilities and devices for COVID-19.

Purpose, Principles, and Guidelines

The purpose of this website is to republish publicly accessible Google Docs to be more mobile-friendly and performant.

Why using Google Docs?

We are using Google Docs so that our content contributors can collaborate easily without the hassle of conventional CMSes.

Principles

What we're striving for:

✅ Performance

Our website must be high-performant because our audience is spread across Indonesia with varying types of devices and network speed. A good measurement of it is Google's Core Web Vitals.

✅ Accessibility

Our website must be accessible so that we can reach more users and help more people.

✅ Up-to-date Information

Any information posted on our website must be up-to-date to the latest version that our content editors published. We can tolerate delays to a certain degree for the sake of web performance, but it should be limited to less than an hour.

✅ Iterative, Incremental Changes

Software development is complex, cognitive work. The simpler we can make something, then generally the easier it is to do. Similarly, the less amount of moving parts a software component has, the less prone it is to errors, and the less maintenance burden it gives us.

One of the simplest ways to reduce complexity is to reduce the scope. We can often postpone the less valuable parts of a large issue and do them later in order to get the most valuable parts into our user's hands faster.

What we're going against:

❌ Counter-productive Cosmetics

We can't afford to hurt web performance or to provide outdated information just for the sake of the beauty of the website.

❌ Expensive Functionalities

We must carefully consider any additional client-side libraries that we include on the website. Unless its benefits outweigh the trade-off that we have to pay, we should avoid adding the functionality. Even if it is proven to be beneficial, we should strive to implement it in the best possible way. An excellent example of it is Google Analytics.

❌ Unmeasured Improvements

For any improvements on the website, we should continuously measure its impact on the Core Web Vitals. If proven to hurt the metrics, we should revert the changes and find another way to implement them without degrading the performance.

Testing Guidelines

In general, these are three guidelines that we need to pay attention to:

  1. Query priorities
  2. Testing appearance and disappearance
  3. Opting in for interactions instead of events

Please ensure that all queries and assertions in your test files comply with those testing guidelines.

Getting Started

To get started running the project locally, please follow the steps below.

First, clone the repository.

git clone https://github.com/kawalcovid19/wargabantuwarga.com.git

Then, install dependencies and fetch data to your local machine. Note that we use Yarn, not npm.

cd wargabantuwarga.com
yarn install
yarn mirror-box

Finally, run the development server.

yarn dev

Open http://localhost:3000 with your browser to see the result.

Learn More

To learn more about Next.js, take a look at the following resources:

You can check out the Next.js GitHub repository - your feedback and contributions are welcome!

Frequently Used Tools

Supporters

Special thanks goes to our supporters.

Netlify GitBook Logo Cypress

Contributing

See our contribution guidelines in these languages:

When contributing to our project, please use English when communicating with other people in issues and/or pull requests. Click here to read why. (Bahasa Indonesia)

Contributors ✨

Thanks goes to these wonderful people (emoji key):


Zain Fathoni

💻 📆 📖 👀 ️️️️♿️ 🤔 🚧 🧑‍🏫 🛡️ 🔧 🌍

Resi Respati

💻 🎨 ️️️️♿️ 📖 🤔 🚧 🧑‍🏫 📆 👀 🛡️ 🔧 🌍

ekamuktia

🐛 💻 🤔 🚧 👀

Eka

💻 🎨 🤔 🚧 👀

Irfan Maulana

🐛 💻 🤔 🚇 🚧 🧑‍🏫 👀

Aditya Purwa

💻 🤔 🚇 🚧 🔧

Hani Husamuddin

💻

nibraswastaken

💻 🚇 🔧 🤔

Kalwabed Rizki

📖 🌍 💻

ihsanrabb

💻

Gilbert Emerson

⚠️

Muhammad Irwan Andriawan

📖 🤔 🐛

Tjandra Darmo

📖

Cristopher

💻 📖

Faiz Azmi Rekatama

💻 🔧

ardiwilda

🖋

Kevin Mingtarja

💻

Rengga Prakoso Nugroho

🖋

Fatih Kalifa

📖 🎨 👀 💻

Bara E. Brahmantika

🤔 🚇 📆

Kukuh Sulistyo

💻

ekiriandra-seo

🤔

Syauqy Nurul Aziz

💻 📖

Muhammad Fauzan

📖 💻 🤔

Hendra Agil Syaputra

💻

Burhan Ahmed

💻

Mukhlis

📖

Kristoporus Nathan Wilianto

💻

Abui

💻

ramarahmanda

🤔 💻

Mohammad Hamzehei

💻

Doni Rubiagatra

⚠️

Umar Hadi Siswanto

📖

Widi-ps

🐛

Ryan Adhi

💻 📖

Bakhtiar Amaludin

💻 🐛

Adam Akbar

💻 🛡️

IGN Bagus Dimas W.

💡 🔣 📖

Nasrul Gunawan

💻

Yusuf

💻

Nur Fadillah Fajar

💻

R.M. Reza

💻

Adinda Praditya

🛡️ 📖

Albarra Naufala Erdanto

🐛 💻

Adib Firman

⚠️

Rangga Putra Pertama

🔧

Anvaqta Tangguh Wisesa

💻

Afif Alfiano

⚠️

M. Zakiyuddin Munziri

💻

FortressValkyrie

💻 ⚠️

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