Skip to content

Commit

Permalink
feat: Improve app information component
Browse files Browse the repository at this point in the history
- Remove distinction between backend and frontend version
- Add "Contribute on Github" link
- Rename component from SoftwareVersion to AppInfo for clearer intent
  and purpose
  • Loading branch information
freshavocado7 authored and Wuestengecko committed Sep 26, 2024
1 parent b532f28 commit c6b8fac
Show file tree
Hide file tree
Showing 7 changed files with 52 additions and 46 deletions.
9 changes: 9 additions & 0 deletions frontend/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions frontend/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
"format": "prettier --write ./**/*.{js,jsx,ts,tsx,css,md,json} --config ./.prettierrc.json"
},
"dependencies": {
"@icons-pack/react-simple-icons": "^10.0.0",
"lucide-react": "^0.439.0",
"react": "^18.3.1",
"react-dom": "^18.3.1",
Expand Down
35 changes: 35 additions & 0 deletions frontend/src/components/AppInfo.jsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
// Copyright DB InfraGO AG and contributors
// SPDX-License-Identifier: Apache-2.0

import { useState, useEffect } from 'react';
import { ROUTE_PREFIX } from '../APIConfig';
import { SiGithub } from '@icons-pack/react-simple-icons';

export const AppInfo = () => {
const [currentVersion, setCurrentVersion] = useState(null);

useEffect(() => {
fetch(`${ROUTE_PREFIX}/static/version.json`)
.then((response) => response.json())
.then((data) => setCurrentVersion(data.git))
.catch((error) => {
console.error(error);
setCurrentVersion({ version: 'Fetch failed' });
});
}, []);

return (
<div className="text-black dark:text-gray-100 print:hidden">
{currentVersion && <p>Version: {currentVersion.version}</p>}
<a
href="https://github.com/DSD-DBS/capella-model-explorer"
className="flex items-center space-x-2 hover:underline"
target="_blank">
<span>Contribute on GitHub</span>
<div className="flex h-6 w-6 items-center justify-center rounded-full bg-custom-light">
<SiGithub className="h-5 w-5 text-black" />
</div>
</a>
</div>
);
};
4 changes: 2 additions & 2 deletions frontend/src/components/InstanceView.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import { useEffect, useRef, useState } from 'react';
import { SVGDisplay } from './SVGDisplay';
import { Spinner } from './Spinner';
import { Printer } from 'lucide-react';
import { SoftwareVersion } from './SoftwareVersion';
import { AppInfo } from './AppInfo';

export const InstanceView = ({ templateName, objectID, endpoint }) => {
const [details, setDetails] = useState([]);
Expand Down Expand Up @@ -112,7 +112,7 @@ export const InstanceView = ({ templateName, objectID, endpoint }) => {
})}
</div>
<div className="my-8 text-center 3xl:hidden">
<SoftwareVersion />
<AppInfo />
</div>
</>
);
Expand Down
39 changes: 0 additions & 39 deletions frontend/src/components/SoftwareVersion.jsx

This file was deleted.

6 changes: 3 additions & 3 deletions frontend/src/views/HomeView.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
import React, { useState, useEffect } from 'react';
import { WiredTemplatesList } from '../components/WiredTemplatesList';
import { API_BASE_URL } from '../APIConfig';
import { SoftwareVersion } from '../components/SoftwareVersion';
import { AppInfo } from '../components/AppInfo';
import { ModelDiff } from '../components/ModelDiff';

export const HomeView = () => {
Expand Down Expand Up @@ -127,8 +127,8 @@ export const HomeView = () => {
<div className="mt-4">
<WiredTemplatesList />
</div>
<div className="mt-8 text-center 3xl:fixed 3xl:bottom-4 3xl:left-4 3xl:block 3xl:text-left">
<SoftwareVersion />
<div className="mt-10 text-center 3xl:fixed 3xl:bottom-4 3xl:left-4 3xl:block 3xl:text-left">
<AppInfo />
</div>
</div>
);
Expand Down
4 changes: 2 additions & 2 deletions frontend/src/views/TemplateView.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ import { useMediaQuery } from "react-responsive";
import { Header } from "../components/Header";
import { InstanceView } from "../components/InstanceView";
import { TemplateDetails } from "../components/TemplateDetails";
import { SoftwareVersion } from "../components/SoftwareVersion";
import { AppInfo } from "../components/AppInfo";

export const TemplateView = ({ endpoint }) => {
let { templateName, objectID } = useParams();
Expand Down Expand Up @@ -108,7 +108,7 @@ export const TemplateView = ({ endpoint }) => {
</main>
</div>
<div className="hidden text-center 3xl:fixed 3xl:bottom-4 3xl:left-4 3xl:mb-0 3xl:mt-0 3xl:block 3xl:text-left">
<SoftwareVersion />
<AppInfo />
</div>
</div>
);
Expand Down

0 comments on commit c6b8fac

Please sign in to comment.