Skip to content

Commit

Permalink
Merge pull request #217 from IFRCGo/feature/release-note
Browse files Browse the repository at this point in the history
Add changelog
  • Loading branch information
samshara authored Dec 19, 2024
2 parents c02e3a3 + f19f43b commit ad5d6bb
Show file tree
Hide file tree
Showing 9 changed files with 79 additions and 9 deletions.
31 changes: 31 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# IFRC Alert Hub

## 1.0.0

## New Features
- Project Setup: Initialized the project with foundational configurations.
- Home Page:
- Added a Map Tab to visually display alerts on an interactive map.
- Added a Table Tab to present alerts in a tabular format.
- Added filters to Map and Table.

- Sources Page: Created a dedicated page to list and display all alert sources.
- Resources Page: Introduced a resources page containing external links.

#### Subscriptions
- Create and Subscribe Alerts:
- Added a modal for users to create and subscribe to alerts directly from the platform.
- Subscription Management:
- Added a Subscriptions Page to display all active subscriptions.
- Introduced a Subscription Detail Page to view detailed alerts associated with each subscription.

#### User Authentication
- Login Page: Implemented a login system for user authentication.
- Register Page: Added a registration feature for new users.
- hCaptcha Integration: Enhanced security by integrating hCaptcha to effectively prevent spam and unauthorized activities.

#### Historical Alerts
- Added a Historical Alerts Page to list and manage past alerts, providing a comprehensive history.

#### Enhancements
- Integrated Google Analytics to monitor website traffic and user behavior. Updated API documentation to reflect the latest features and endpoints.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2024 IFRC Alert Hub

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
2 changes: 1 addition & 1 deletion backend
Submodule backend updated 0 files
7 changes: 6 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,13 @@
{
"name": "ifrc-alert-hub",
"version": "0.0.1",
"version": "1.0.0",
"type": "module",
"private": true,
"license": "MIT",
"repository": {
"type": "git",
"url": "git+https://github.com/IFRCGo/alert-hub-web-app.git"
},
"scripts": {
"start": "vite",
"build": "vite build",
Expand Down
12 changes: 10 additions & 2 deletions src/components/GlobalFooter/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ import { _cs } from '@togglecorp/fujs';
import Link from '#components/Link';
import {
appCommitHash,
appPackageName,
appRepositoryUrl,
appVersion,
} from '#config';

Expand All @@ -28,14 +30,20 @@ function GlobalFooter(props: Props) {
} = props;

const strings = useTranslation(i18n);
const versionTag = `${appPackageName}@${appVersion}`;
const versionUrl = `${appRepositoryUrl}/releases/tag/${versionTag}`;
const copyrightText = resolveToComponent(
strings.footerIFRC,
{
year,
appVersion: (
<span title={appCommitHash}>
<Link
href={versionUrl}
title={appCommitHash}
external
>
{appVersion}
</span>
</Link>
),
},
);
Expand Down
4 changes: 4 additions & 0 deletions src/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ const {
APP_COMMIT_HASH,
APP_VERSION,
APP_HCAPTCHA_SITEKEY,
APP_PACKAGE_NAME,
APP_REPOSITORY_URL,
} = import.meta.env;

export const appTitle = APP_TITLE; // not used
Expand All @@ -15,3 +17,5 @@ export const mapboxToken = APP_MAPBOX_ACCESS_TOKEN;
export const hCaptchaKey = APP_HCAPTCHA_SITEKEY;
export const appCommitHash = APP_COMMIT_HASH;
export const appVersion = APP_VERSION;
export const appPackageName = APP_PACKAGE_NAME;
export const appRepositoryUrl = APP_REPOSITORY_URL;
2 changes: 2 additions & 0 deletions src/declarations/env.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ interface ImportMetaEnv extends ImportMetaEnvAugmented {
// The custom environment variables that are passed through the vite
APP_COMMIT_HASH: string;
APP_VERSION: string;
APP_PACKAGE_NAME: string;
APP_REPOSITORY_URL: string;
}

interface ImportMeta {
Expand Down
6 changes: 1 addition & 5 deletions src/views/Unsubscribe/styles.module.css
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
.unsubscribe {
display: flex;
flex-direction: column;
gap: var(--go-ui-spacing-xs);
align-items: center;
.unsubscribe {
text-align: center;
}
3 changes: 3 additions & 0 deletions vite.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import { compression } from 'vite-plugin-compression2';
import checker from 'vite-plugin-checker';
import { ValidateEnv as validateEnv } from '@julr/vite-plugin-validate-env';
import { VitePluginRadar } from 'vite-plugin-radar';
import pkg from './package.json';

import alertHubPackage from './package.json';
import envConfig from './env';
Expand All @@ -22,6 +23,8 @@ export default defineConfig(({ mode }) => {
define: {
'import.meta.APP_COMMIT_HASH': JSON.stringify(commitHash),
'import.meta.env.APP_VERSION': JSON.stringify(alertHubPackage.version),
'import.meta.env.APP_PACKAGE_NAME': JSON.stringify(env.npm_package_name),
'import.meta.env.APP_REPOSITORY_URL': JSON.stringify(pkg.repository.url.match(/https:\/\/github\.com\/[^ ]+/)?.[0].replace(/\.git$/, '')),
},
plugins: [
isProd ? checker({
Expand Down

0 comments on commit ad5d6bb

Please sign in to comment.