Code Monkey home page Code Monkey logo

feminist-covid-response-frontend's Introduction

Feminist Covid-19 Response

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/


Table of contents


Getting Started

For development, you will only need Node.js installed on your environement.

Node installation on OS X

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

Node installation on Linux

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

Node installation on Windows

Just go on official Node.js website & grab the installer. Also, be sure to have git available in your PATH, npm might need it.

Installation

    $ git clone https://github.com/sruti/covid19-riskfactors-app.git
    $ cd covid19-riskfactors-app
    $ npm install

Start and Watch

    $ npm start

Component Hierarchy

Component hierarchy graph


Languages and Tools

React

i18next

react-ga


What are you trying to do?

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 About Section

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, and
  • public/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:

  1. Change the branch to dev;
  2. Add the html tag in About.js;
  3. Instead of pasting the contents in the tag itself, use a descriptive key and write it in the i18next syntax: {t("your-key")};
  4. 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.
  5. Update the files (either on github, or if you are a developer, then just push a commit) and inform the maintainer about the change.

Change Principles Section

In order to change "Thank you" list (that appears in the About section), follow these steps:

  1. Change the branch to dev;
  2. 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.
  1. 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!
  1. Update the files (either on github, or if you are a developer, then just push a commit) and inform the maintainer about the change.

Change PDFs

In order to change the PDFs (that appear in the Principles section), follow these steps:

  1. Change the branch to dev;
  2. Navigate to scr/assets/files;
  3. Copy the name and delete the file you no longer need;
  4. Add the new file -- make sure to name it exactly the same as the deleted file;
  5. If you are a developer, then just push a commit, and inform the maintainer about the change.

Change Principles Section

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, and
  • public/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:

  1. Change the branch to dev;
  2. Add the html tag in PrinciplesContainer.js;
  3. Instead of pasting the contents in the tag itself, use a descriptive key and write it in the i18next syntax: {t("your-key")};
  4. 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.
  5. Update the files (either on github, or if you are a developer, then just push a commit) and inform the maintainer about the change.

Update the legend

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, and
  • public/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:

  1. Change the branch to dev;
  2. Add the html tag in Legend.js;
  3. Instead of pasting the contents in the tag itself, use a descriptive key and write it in the i18next syntax: {t("your-key")};
  4. 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.
  5. Update the files on github (or if you are a developer, then just push a commit) and inform the maintainer about the change.

Update other text

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, and
  • public/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:

  1. Change the branch to dev;
  2. Add the html tag in the correct component;
  3. Instead of pasting the contents in the tag itself, use a descriptive key and write it in the i18next syntax: {t("your-key")};
  4. 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.

Contributing

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.

Known issues

Visit issues section.

Contributors


Sylwia Vargas

๐Ÿ’ป ๐Ÿ› ๐Ÿ“– ๐Ÿ’ก

Annie Souza

๐Ÿ’ป ๐Ÿ› ๐Ÿš‡ ๐Ÿ’ก

License

MIT

feminist-covid-response-frontend's People

Contributors

sylwiavargas avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.