Skip to content

Latest commit

 

History

History
39 lines (22 loc) · 2.38 KB

README.md

File metadata and controls

39 lines (22 loc) · 2.38 KB
Raw

International Women Day, March 8th, 2021 .
Women in leadership, Achieving an equal future
in a COVID-19 world.

Primary Motivation

This Web Application was built to appreciate the hard-work and effort put in by women around the world and can be accessed here.

Secondary Motivations

  • This application was built to illustrate how React can be used as a frontend interface displaying data from a CMS application such as a Wordpress application through it REST API.

Accesibility:

Local Installation

Note: All data within this application is served from a Wordpress Application. Hence you should have Wordpress setup on your local machine for local development. To get started, you can launch wordpress from a docker container using docker-compose with this configuration file.

  • Clone this repository locally using git cli with the git clone {REPO URL} command, and install application dependencies using the yarn install command.

  • Create a .env file in the root directory for securely storing your Wordpress API Endpoint in the following field;

    REACT_APP_WORDPRESS_ENDPOINT=`${WORDPRESS_REST_ENDPOINT}/wp-json/wp/v2`

Testing:

All End-to-end(E2E) tests within this application are written using Cypress. All network requests within the application are tested using Moxios.

Contributions

We welcome and appreciate pull requests from everyone.

You can participate in many ways. The application codes are available in their respective files for this project. You can get all of them, change anything and send the changes back.

Commit changes

Easily contribute to the content of the style guide by adding new recommendations, making corrections or adding examples in the form of images or videos:

If you have Git installed on your system, cloning is preferred way to get the contents since it allows you to contribute back.