Skip to content

Commit

Permalink
docs: 📝 updated readme and minor refactoring done
Browse files Browse the repository at this point in the history
  • Loading branch information
WasiqB committed Oct 16, 2024
1 parent 44eeed6 commit 7632697
Show file tree
Hide file tree
Showing 7 changed files with 25 additions and 7 deletions.
16 changes: 11 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,23 @@
# 📊 Ultra-Reporter App

**Ultra-Reporter** is your go-to tool for transforming your TestNG (Maven, Java) test results into stunning reports.
[Ultra-Reporter](https://ultra-reporter-app.vercel.app/) is your go-to tool for transforming your TestNG (Maven, Java) test results into stunning reports.

Built on the power of Next.js and Tailwind CSS, this reporter takes your raw test results from TestNG and presents it in a beautiful, easy-to-digest format. Simplify your test reporting with just a one click!

## 📷 Generated Report

![Report page 1](/public/report-1.png)
![Report page 2](/public/report-2.png)
![Report page 3](/public/report-3.png)

## 🚀 Quick start

Checkout this demo video to see how to use Ultra-Reporter:

[![Ultra Reporter App Demo Video](https://img.youtube.com/vi/l2pk7LAq50I/0.jpg)](https://www.youtube.com/watch?v=l2pk7LAq50I)

Following are the steps to get started with Ultra-Reporter:

- Run your TestNG tests using it's default reporter listeners
- ![Step 1](/public/step-1.png)
- ![Step 2](/public/step-2.png)
Expand All @@ -24,7 +31,8 @@ Ultra-Reporter leverages cutting-edge technologies to provide fast, efficient, a
- **[Next.js 14](https://nextjs.org/)**: Dynamic, server-rendered React apps.
- **[TypeScript](https://www.typescriptlang.org/)**: Strongly typed for better reliability and scalability.
- **[Tailwind CSS](https://tailwindcss.com/)**: Beautiful, responsive design without the hassle.
- **[Shadcn/UI](https://ui.shadcn.com/)** & **[Daisy UI](https://daisyui.com/)**: Sleek UI components for a polished user experience.
- **[Shadcn/UI](https://ui.shadcn.com/)**, [Magic UI](https://magicui.design/) & **[Daisy UI](https://daisyui.com/)**: Sleek UI components for a polished user experience.
- **[Vercel](https://vercel.com/)**: Next.js is deployed on Vercel, a platform for static websites and serverless functions.

## ⏱️ What's Next?

Expand All @@ -44,9 +52,7 @@ Feel free to reach out for any queries, collaborations, or feedback!

## 💗 Repo Activity

<a href="https://github.com/WasiqB/ultra-reporter-app/graphs/contributors">
<img src="https://contrib.rocks/image?repo=wasiqb/ultra-reporter-app" />
</a>
[![Repo contributors](https://contrib.rocks/image?repo=wasiqb/ultra-reporter-app)](https://github.com/WasiqB/ultra-reporter-app/graphs/contributors)

![Ultra Reporter App Repo activity](https://repobeats.axiom.co/api/embed/40bf4829da597315850c30a8909fcf40a8b5a00c.svg "Repobeats analytics image")

Expand Down
12 changes: 12 additions & 0 deletions components/home/feature.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@ import {
CircleAlert,
Group,
MousePointerClick,
ParkingCircle,
Table,
Timer,
} from 'lucide-react';

const features = [
Expand All @@ -18,6 +20,11 @@ const features = [
description: 'Generate insightful charts and graphs from your data',
icon: BarChartIcon,
},
{
title: 'Test Execution Trends',
description: 'Analyze your test execution trends over time',
icon: Timer,
},
{
title: 'Detailed Results',
description:
Expand All @@ -39,6 +46,11 @@ const features = [
description: 'View your tests groups in which they are categorized',
icon: Group,
},
{
title: 'View Test Parameters',
description: 'View your tests parameters and their values',
icon: ParkingCircle,
},
];

export const Features = (): JSX.Element => {
Expand Down
2 changes: 1 addition & 1 deletion components/home/nav-bar.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ export const NavBar = ({

return (
<nav
className={`fixed left-0 right-0 top-0 z-50 transition-all duration-300 ${
className={`left-0 right-0 top-0 z-50 transition-all duration-300 ${
isScrolled
? 'bg-background/80 shadow-md backdrop-blur-md'
: 'bg-transparent'
Expand Down
2 changes: 1 addition & 1 deletion components/home/open-source.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import { RainbowButton } from '@/components/ui/rainbow-button';

export const OpenSource = (): JSX.Element => {
return (
<section className='mb-10 mt-10 text-center'>
<section className='mb-10 mt-16 text-center'>
<h2 className='mb-4 text-3xl font-bold text-foreground'>
We are proudly Open Source ❤️
</h2>
Expand Down
Binary file modified public/report-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified public/report-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/report-3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 7632697

Please sign in to comment.