Skip to content

Commit

Permalink
Release v0.0.1-beta (#65)
Browse files Browse the repository at this point in the history
* Ah grommet themes (#52)

* Grommettify settings panel
* Grommetify descriptive files
*  Switching themes w/ grommet
*  Fixed closing bracket

* Styles - layout (#53)

* Panel height fixed
* Remove console log in app
* Side icon panels style
* Lock down sizing for main panel - responsive
* Omni box and bottom panel sizing is responsive and margins are consistent
* Smooth transitions everywhere and margins remade
* Login page - whole page swirl
* Login page clean up
* Beginning to revert back to normal tabs
* Reset tabs
* Reset button and tool tip added
* Bottom results overflow is hidden and responsive
* Clean up sizing and look of db tables
* Add empty states for tables
* Reformat spacing on login page
* Attempt to make tables less ugly
* some margin/padding issues
* Fix responsive ness of info panel and top header - no longer smushed
* Margins for empty state

* buildable, packagable, beta-releasable!  (#54)

* Cleanup
* Refactor pg client connections
* Settings panel logout

* Final Tweaks (#55)

* Add note about the pin
* Update font and style on settings panel
* Add warning for selecting more than 2 tables
* Add margin to results
* Added font everywhere
* Add settings info

* fix (#59)

* icon for electron (#57)

* Icon added

* fix

* Read Me (#61)

* README updated

* test (#62)

* Update README.md (#63)

* Update README.md (#64)
  • Loading branch information
katesmatthews authored and aliicewong committed Jun 27, 2019
1 parent d6e004f commit 6f3eee9
Showing 1 changed file with 67 additions and 2 deletions.
69 changes: 67 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,68 @@
# SeeQL
<p align="center">
<img width="250" alt="SeeQL Title" src="https://user-images.githubusercontent.com/29069478/60289605-ca915b80-98e4-11e9-943f-c40cb919c21e.png">
</p>

now loading...
---

Welcome to **SeeQL (beta)**: An easy-to-use desktop application that helps you visualize your database tables (including all foreign and primary key relationships), to quickly generate complex queries.


## Getting Started

#### Requirements

You'll need a Postgres database to connect to.

#### How to Install

Beta Release 0.0.1

**MacOS:** [seeql-0.0.1.dmg](https://github.com/oslabs-beta/seeql/releases/download/untagged-bc5bc2c547e0407d958d/SeeQL-0.0.1.dmg)

*Note:* For now, you might need to go to your security settings to allow the app run on your system to allow the application to run.

Or from the **terminal**, run:

```
git clone https://github.com/oslabs-beta/seeql.git
cd seeql
yarn
yarn run build
yarn start
```


## Features

**Logging In**

You have the option to log in with a `postgres://` URI connection string, or enter your database credentials individually.

![Login](https://user-images.githubusercontent.com/29069478/60288146-936d7b00-98e1-11e9-8bf3-2cffdef82ff0.gif)

**Viewing Database Information**

After logging in, you'll see three sections - the side panel, the input box, and the database tables section. In the tables section, when you **hover** over a primary key in a table, any references to this **primary key** in other tables will be highlighted. Similarly, if you hover over a **foreign key** in a table, its related primary key will be highlighted.

Click on any table's **info** icon to view its information in the side panel.

Choose the **Search** option above the input box to filter which tables will be displayed. You can **pin** tables to the top of the page for your convinience by clicking on any table's pin icon.

![finalSeeQLViewDB](https://user-images.githubusercontent.com/29069478/60296862-00d6d700-98f5-11e9-9bf5-c0e15fee21ee.gif)

**Generating SQL queries & Viewing the results**

You can write a **SQL SELECT query** in the SQL input box, or automatically generate a query by clicking on the rows of a table. Once your query is complete, click **execute query**. If your query has any errors, an error message will display telling you exactly where the error occured.

![finalGenerateQuery](https://user-images.githubusercontent.com/29069478/60296884-0af8d580-98f5-11e9-8d26-06cb5c58f270.gif)

After clicking execute, you'll be able to see your results in the **Results** section. Clicking on a column name will sort your table data accordingly.
You can filter which rows are visible by clicking the search icon next to each column name.


## Resources

Built on Electron, React and Typescript

**Creators:** [Kate Matthrews](http://github.com/katesmatthews), [Tyler Sayles](https://github.com/saylestyler), [Ariel Hyman](https://github.com/AHyman18), [Alice Wong](https://github.com/aliicewong)

0 comments on commit 6f3eee9

Please sign in to comment.