Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 29 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,12 @@
# Hyperion
<center>
<img src="assets/logo.jpg"/>
</center>

**Note:** An overview of our security policies is available [here](/SECURITY.md). *Please read this document before using our app. Using our app constitues acknowledgment of the disclaimers presented in that document at the time of sign-up.*



# Table of Contents

> - [Description]()
Expand All @@ -14,27 +19,47 @@

# Description

Dynamic forecasting of PostgreSQL database performance. Problem. Solution. Why we built it.
Hyperion: A PostgreSQL analytic tool to test and compare actual dynamic query runtimes with query runtimes calculated by PostgreSQL's EXPLAIN ANALYZE profiling tool.

# Features

So many great features to come!
> - Overview
> - Databases
>> - On the Database page, users can connect to their databases by either providing the database URI or manually providing connection details (host, port, database name, and user credentials)
<center>
<img src="assets/addingdatabase.gif"/>
</center>

> - Queries
>> - On the Queries page, users can select a database, input queries, and optional parameter placeholders.
<center>
<img src="assets/addingquery.gif"/>
</center>

> - Run Tests
>> - On the Run Test page, users can select a database, and query. The run test function will then display the actual query runtime measured by the PostgreSQL server’s CPU clock time as well as query runtime provided via the explain analyze command and associated summary statistics (min, max, median, sd, q1,q3).
<center>
<img src="assets/RunningTest.gif"/>
</center>



# How to Use

A hosted version is available [at this link](#).

If you prefer to run it locally, you can also fork and clone the repository and run the production version locally using `node server/server.js` at the root directory.

A step-by-step tutorial is also available [here](/TUTORIAL.md).

# Technologies

- Node
- React
- Redux
- PostgreSQL
- etc...
- Typescript
- Material UI
- Plotly.js

# Dependencies

Expand Down
5 changes: 0 additions & 5 deletions TUTORIAL.md

This file was deleted.

Binary file added assets/RunningTest.gif
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 assets/addingdatabase.gif
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 assets/addingquery.gif
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 assets/logo.jpg
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 assets/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.