go-web-app-develop/README.md

IFRC GO

IFRC GO is the platform of the International Federation of Red Cross and 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.

Built With

Getting Started

Below are the steps to guide you through preparing your local environment for 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.

Prerequisites

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

1. Git
2. Node.js as specified under engines section in package.json file
3. pnpm as specified under engines section in package.json file
4. Alternatively, you can use Docker to build the application.

Make sure the correct versions of pnpm and Node.js are installed. They are specified under engines section in package.json file.

Local Development

1. Clone the repository using HTTPS, SSH, or GitHub CLI:

   git clone https://github.com/IFRCGo/go-web-app.git # HTTPS
   git clone git@github.com:IFRCGo/go-web-app.git # SSH
   gh repo clone IFRCGo/go-web-app # GitHub CLI
   

2. Install the dependencies:

   pnpm install
   

3. Create a .env file in the app directory and add variables from env.ts. Any variables marked with .optional() are not mandatory for setup and can be skipped.

   cd app
   touch .env
   

   Example .env file

   APP_TITLE=IFRC GO
   APP_ENVIRONMENT=testing
   ...
   

4. Start the development server:

   pnpm start:app
   

Contributing

• Check out existing Issues and Pull Requests to contribute.
• To request a feature or report a bug, create a GitHub Issue.
• Contribution Guide →
• Collaboration Guide →

Additional Packages

The repository hosts multiple packages under the 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 IFRC GO UI components library. It is hosted on Chromatic.

IFRC GO Backend

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

Previous Repository

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

Community & Support

• Visit the IFRC GO Wiki for documentation of the IFRC GO platform.
• Stay informed about the latest project updates on Medium.

License

MIT