A volunteer online data repository of information on feminist principles and actions, as well as policy responses to the COVID crisis.
Explore online: http://feministcovidresponse.com/
- Getting Started
- Installation
- Start and Watch
- Component hierarchy
- Languages and tools
- What are you trying to do?
- Contributing
- License
For development, you will only need Node.js installed on your environement.
You will need to use a Terminal. On OS X, you can find the default terminal in
/Applications/Utilities/Terminal.app
.
Please install Homebrew if it's not already done with the following command.
$ ruby -e "$(curl -fsSL https://raw.github.com/Homebrew/homebrew/go/install)"
If everything when fine, you should run
brew install node
sudo apt-get install python-software-properties
sudo add-apt-repository ppa:chris-lea/node.js
sudo apt-get update
sudo apt-get install nodejs
Just go on official Node.js website & grab the installer.
Also, be sure to have git
available in your PATH, npm
might need it.
$ git clone https://github.com/sruti/covid19-riskfactors-app.git
$ cd covid19-riskfactors-app
$ npm install
$ npm start
This section is entirely devoted to the folks who are not developers or are not used to working with JS frameworks. So, what are you trying to do:
- Change the wording of 'About' section
- Change the Thank Yous
- Change the pdfs
- Change the wording of 'Principles' section
- Update the wording of 'Legend' on response tracker
- Update the wording of 'Menu' items, types, categories or countries
In order to change "About" Section, please navigate to src/components/About.js
. You will see that in the place of a standard paragraph, we have the i18next
syntax, for example:
<p className="about-intro">{t("intro")} </p>
This site was built with localization in mind, meaning, it is available in three language versions. In order to change this paragraph, you will work with any or all of these three files, each one is responsible for a different language version:
public/locales/en/about.json
,public/locales/es/about.json
, andpublic/locales/fr/about.json
.
Next, look for the key intro
and make changes in the corresponding value.
If you want to add additional text on the page, follow this steps:
- Change the branch to
dev
; - Add the html tag in
About.js
; - Instead of pasting the contents in the tag itself, use a descriptive key and write it in the
i18next
syntax:{t("your-key")}
; - Navigate to the three files and add the key, together with the text you want it to denote as the key's value -- order does not matter, you can just put it at the end or in the middle; Remember: If you add only the English translations, then in the French and Spanish version of the page the English paragraph will be rendered.
- Update the files (either on github, or if you are a developer, then just push a commit) and inform the maintainer about the change.
In order to change "Thank you" list (that appears in the About section), follow these steps:
- Change the branch to
dev
; - Navigate to
scr/assets/data/appreciation.js
. You will see three variables:
database
- these are the database volunteers;coordination
- these are the coordinators;orgs
- these are the NGOs and individuals.
- Add the name to the appropriate variable following the pattern you see:
- it needs to be in the quotation marks (""),
- if there's another name before it or after it, remember to add the comma (,). NOTE: The order matters!
- Update the files (either on github, or if you are a developer, then just push a commit) and inform the maintainer about the change.
In order to change the PDFs (that appear in the Principles section), follow these steps:
- Change the branch to
dev
; - Navigate to
scr/assets/files
; - Copy the name and delete the file you no longer need;
- Add the new file -- make sure to name it exactly the same as the deleted file;
- If you are a developer, then just push a commit, and inform the maintainer about the change.
In order to change "Principles" Section, please navigate to src/containers/PrincipleContainer.js
. You will see that in the place of a standard paragraph, we have the i18next
syntax, for example:
<h1 className="principles-title">{t("title")}</h1>
This site was built with localization in mind, meaning, it is available in three language versions. In order to change this paragraph, you will work with any or all of these three files, each one is responsible for a different language version:
public/locales/en/princ.json
,public/locales/es/princ.json
, andpublic/locales/fr/princ.json
.
Next, look for the key title
and make changes in the corresponding value.
If you want to add additional text on the page, follow this steps:
- Change the branch to
dev
; - Add the html tag in
PrinciplesContainer.js
; - Instead of pasting the contents in the tag itself, use a descriptive key and write it in the
i18next
syntax:{t("your-key")}
; - Navigate to the three files and add the key, together with the text you want it to denote as the key's value -- order does not matter, you can just put it at the end or in the middle; Remember: If you add only the English translations, then in the French and Spanish version of the page the English paragraph will be rendered.
- Update the files (either on github, or if you are a developer, then just push a commit) and inform the maintainer about the change.
In order to change "Legend" section on the Response Tracker, please navigate to src/components/Legend.js
. You will see that in the place of a standard paragraph, we have the i18next
syntax, for example:
<p className="legend-types-p">{t("TYPES")}:</p>
This site was built with localization in mind, meaning, it is available in three language versions. In order to change this paragraph, you will work with any or all of these three files, each one is responsible for a different language version:
public/locales/en/legend.json
,public/locales/es/legend.json
, andpublic/locales/fr/legend.json
.
Next, look for the key TYPES
and make changes in the corresponding value.
If you want to add additional text on the page, follow this steps:
- Change the branch to
dev
; - Add the html tag in
Legend.js
; - Instead of pasting the contents in the tag itself, use a descriptive key and write it in the
i18next
syntax:{t("your-key")}
; - Navigate to the three files and add the key, together with the text you want it to denote as the key's value -- order does not matter, you can just put it at the end or in the middle; Remember: If you add only the English translations, then in the French and Spanish version of the page the English paragraph will be rendered.
- Update the files on github (or if you are a developer, then just push a commit) and inform the maintainer about the change.
In order to change any other text, please navigate to its component file. You will see that in the place of a standard paragraph, we have the i18next
syntax, for example:
<p className="legend-types-p">{t("TYPES")}:</p>
This site was built with localization in mind, meaning, it is available in three language versions. In order to change this paragraph, you will work with any or all of these three files, each one is responsible for a different language version:
public/locales/en/translation.json
,public/locales/es/translation.json
, andpublic/locales/fr/translation.json
.
Next, look for the TYPES
key and make changes in the corresponding value.
If you want to add additional text on the page, follow this steps:
- Change the branch to
dev
; - Add the html tag in the correct component;
- Instead of pasting the contents in the tag itself, use a descriptive key and write it in the
i18next
syntax:{t("your-key")}
; - Navigate to the three files and add the key, together with the text you want it to denote as the key's value -- order does not matter, you can just put it at the end or in the middle; Remember: If you add only the English translations, then in the French and Spanish version of the page the English paragraph will be rendered.4. Update the files (either on github, or if you are a developer, then just push a commit) and inform the maintainer about the change.
Pull requests are welcome. Please make sure that your PR is well-scoped. For major changes, please open an issue first to discuss what you would like to change.
Visit issues section.
Sylwia Vargas ๐ป ๐ ๐ ๐ก |
Annie Souza ๐ป ๐ ๐ ๐ก |