ifrcgo / go-web-app Goto Github PK

IFRC GO is the platform of the Red Cross Red Crescent, aimed at connecting crucial information on emergency needs with the appropriate response. This repository houses the frontend source code for the application, developed using React, Vite, and associated technologies.

Below are the steps to guide you through preparing your local environment for the IFRC GO Web application development. The repository is set up as a monorepo. The app directory houses the application code, while the packages directory contains related packages, including the IFRC GO UI components library. Please review the Contribution Guidelines and Collaboration Guidelines to gain a deeper understanding of the repository's structure.

To begin, ensure you have network access. Then, you'll need the following:

1. Git
2. Node.JS version >=18 / 20+
3. Yarn 1
4. Alternatively, you can use Docker to build the application.

1. Clone the repository using HTTPS, SSH, or Github CLI

git clone https://github.com/IFRCGo/go-web-app.git #HTTPS
git clone [email protected]:IFRCGo/go-web-app.git #SSH
gh repo clone IFRCGo/go-web-app #Github CLI

2. Install the dependencies

yarn install

3. Copy app/.env.example to app/.env and update the variables

cp app/.env.example app/.env

4. Start the development server

yarn start:app

Have a look through existing Issues and Pull Requests that you could help with. If you'd like to request a feature or report a bug, please create a GitHub Issue using one of the templates provided.

See contribution guide →

See collaboration guide →

The repository hosts multiple packages under packages directory.

1. IFRC GO UI is a React UI components library tailored to meet the specific requirements of the IFRC GO community and its associated projects.
2. IFRC GO UI Storybook serves as the comprehensive showcase for the components library.It is hosted on chromatic.

The backend that serves the frontend application is maintained in a separate repository.

Go Frontend is the previous version of the project which contains the original codebase and project history.

• Visit the IFRC GO Wiki for documentation of the IFRC GO platform.
• Create GitHub Issues for bug reports and feature requests.
• Tweet at @ifrcgo on Twitter.
• Stay informed about the latest project updates at Medium.

MIT