Hello friends!
I am really happy to share with you that a website that I recently poured a lot of my heart into has just reached 12k visitors! I'd like to share with you the process and my learnings.
The website, Feminist Covid Response, is a volunteer online data repository of information on feminist principles and actions, as well as policy responses to the COVID crisis. Together with Annie Souza we volunteered our time and tech skills for Women's Environment and Development Organization to bring this to fruition.
Read more about:
Demo πΌ
You can explore the page on your own or just see it here:
Here's how it looks:
About the Website π₯
The website was created together with Annie Souza for Women's Environment and Development Organization and it has been continuously visited by folks from 157 countries totalling to 12k visits over 1 week!
It is really humbling to see that our app has reached folks literally around the world:
It's not only great because it flatters our egos β more importantly, it shows that these subjects are important to so many people and that the work that went into making this website responsive, accessible and light paid off. Learning to code in the US, one oftentimes forgets that not the whole world uses iphones or macs and that (sadly) there is a portion of folks who still feel comfortable with Internet Explorer.
The Process πΊ
β¨ the task β¨
Annie and I received wireframes from WEDO, together with the deliverables. The NGO prioritized these features:
- it should be light for folks who have limited data;
- it should be available in three languages (both the static and externally-fetched data);
- it should be accessible;
- it should be ready in two-three weeks;
- the solutions should be cheap (free) and sustainable as there's no budget.
It was a great challenge not only because of the time constraints but also because of some of the features we always wanted to implement but never had time to do so. We were really excited that we were building something that was designed to be responsive, international and accessible.
β¨ tech stack: backend β¨
Our backend is Ruby on Rails hosted on Heroku:
- Ruby on Rails
- PostgreSQL - database
- Active Record - Object Relational Mapping system
- Active Model Serializers - serialization
Initially, because we worked with a third volunteer dev, our backend was Contentful, which seemed like a great idea given that it is a CMS (Content Management System) and it would be possible for the volunteers to just directly add entries there. However, we hit a wall after a wall trying to migrate 1,500+ entries from excel sheets (crowd-sourced by volunteers) to the database. Given time pressure, we gave ourselves deadline to try out different approaches from their docs, stackOverflow and their slack and as none of that seemed to work, we just set up a new backend, which ironically took less time than the research on Contentful. Below you see the domain model:
β¨ tech stack: frontend β¨
Our frontend is React hosted on Netlify:
- React
- React-i18next β localization
- react-ga - analytics
Initially, we wanted to use Tailwind for CSS but given that back then we already assumed we'd need to learn Contentful and also prioritized working with React Hooks, we decided to work with what we were most comfortable with: pure CSS with good ol' media queries. We tried to make sure our components would be reusable but not unresonably abstracted. Below is our component hierarchy:
β¨ coding β¨
Despite full-time job, Annie and I decided to work on this project every day. We would start the day with a slack stand up where we'd discuss next steps and distribute tasks for the day, and then would have an in-person stand down where we'd update each other on the progress, update Github issues and perhaps debug some parts together.
Once a week, we'd have a meeting with a WEDO representative for updates and feedback. Every few weeks, we'd have a new portion of data to migrate to the database.
β¨ git workflow β¨
When it comes to the git workflow, we'd follow this practice:
- the git repo belongs to the organization and we are both added there as collaborators;
- there are two standard branches:
masteranddev; - whenever you start working on the new feature, navigate to
dev, rungit pull origin dev, thengit checkout -b nameOfTheFeature; this is the branch where you'll push the code; - once the feature is βdoneβ and you checked whether itβs not bugging out, merge it to
devand request review; - if itβs okay, the other person merges it to
masteror you both merge it together and hold a little merge party;
β¨ feedback β¨
Initially, we were open to feedback from a few different stakeholders at WEDO but given the quick pace and time pressure, that became a bit messy. We pivoted and had one contact point at WEDO who was responsible for gathering all the feedback and presenting it to us.
β¨ handover β¨
Now that our work is done and WEDO actually is able to work with a web agency where people have only one job, we are handing this project over. In order to do that, we prepared exhaustive docs and will hold frequent communication.
Challenges and Fixes π‘
β¨ Google Translate is not free β¨
While the menu and some static parts of the page are translated using localization package, we also need the fetched data to appear in the correct language. Initially, we wanted to rely on Google Translate API for translating the backend data. It turned out that Google Translate is not free and given the traffic on the website, it could actually become quite costly and inefficient. Instead, we thought of translating the entries before they are added to the backend so the cost would be lower. However, because we didn't get to building CMS, we actually had 1,500+ entries to translate, which we managed by building a web scraping script and using free google translate page Β―_(γ)_/Β―
β¨ Heroku sleeps β¨
Because of our very limited (non-existent) budget, we had to deploy the app to Heroku on the free plan, which means that if unused for 30 minutes, the page would "fall asleep" and the wake-up would take max. 15 seconds. No one has this much patience! We solved it in two ways:
- as soon as a person enters the main page, a "ping" is sent to Heroku to wake it up and the fetch begins;
- if the user enters the page on the endpoint that should display fetched data, we first show the 50 first records that are not fetched but hardcoded, and as soon as the fetch to heroku is done, it just adds the remaining thousand entries to the end of the list. It's not a perfect solution and if you have any better to offer, please share you insight!
β¨ Not everyone uses an Iphone and Mac β¨
I'm stating the obvious here but we needed to remember that whatever change we introduce, we need to check how it looks on all browsers, in different resolutions and on different orientations (horizontal/vertical). There are still a few bugs or parts that could be better but aren't there always?
Key Take-Aways π
β¨ self-care is important β¨
When you work on a project you deeply care about, it is easy to put everything aside and just work yourself to sleep. That is not healthy. When planning for the project, include self-care time in your project timeline and downtime with your team because the more connected you are, the easier it is debug stuff together. We definitely were burned out after this project.
β¨ plan CSS well before you start coding β¨
We received wireframes from a person who's not professional designer and so what looked good on a canvas-made picture looked not perfect in some browsers or dimensions. We made a mistake of not asking for wireframes for different dimensions/devices and also by just playing CSS by the ear (making a big simplification here). Because of that, it was so much more difficult to introduce major changes along the way. We unnecessarily spent a lot of time over stuff that could have been managed better had we defined a CSS stylebook beforehand. You code, you learn.
β¨ if you're developing for an NGO, use CMS β¨
The page, although works okay and fulfills the wireframes we got, is not entirely satisfying for the NGO we worked with because any data they want to change needs to go through us or some other developer. It would have been much easier and more sustainable had we used Wordpress with React frontend from the get-go. However, initially, it didn't seem like there would be much changes as the project evolved over time.
β¨ Learn one thing at a time β¨
Initially, we wanted to learn Tailwind, Contentful, localization, analytics, SEO and broaden our knowledge of Netlify, Heroku and Hooks. However, it's best to focus on one thing at a time, especially if you are a person prone to impostor syndrome (like myself). Don't try to challenge yourself on every step because that may turn out inefficient and paralyzing.
Top comments (11)
So nice you pulled it off in such a tight schedule (with a full time job). It is a meaningful project.
So, are you going to learn Tailwind now?π They have a great screencasts.
Ah, yes! I actually came up with a mini side project just to learn Tailwind for the next big thing. I think I should also learn how to connect frontend with Wordpress because given that I really want to volunteer my skills for greater good, I think NGOs would appreciate this level of independence (sadly).
Cool! I've never used Wordpress myself. In my personal projects, I use sanity. Anyways, update your learning process. π
This is epic. Great job!!
Thank you for your kind words β€οΈ Weβve worked really hard and I wanted to record the process and learnings so Iβll be smarter next time π
Congrats! Huge impact project!!
Thank you! I really want to volunteer my skills to help out different NGOs because tech products are usually waaaay outside their budgets.
11k in 1.5 monthsπ€― is a huge milestone. That's amazing.π₯³π₯³
Thank you! We didn't know that the project would reach this many people and the first week the site went live gave us a massive impostor syndrome.
Great work!! Is the website source code open-sourced on Github so people can submit PR?
Thank you! It is now being handed over to a web dev agency so they can maintain it and build further. Maybe it will be open-sourced (we are advocating for that and i know that the WEDO org also likes the idea :) ). I'll keep you updated!