Skip to content

Commit

Permalink
Merge branch 'main' into v13-launch
Browse files Browse the repository at this point in the history
  • Loading branch information
choukevin612 authored Feb 8, 2024
2 parents 14f0079 + 97dcd7d commit 30484de
Show file tree
Hide file tree
Showing 12 changed files with 275 additions and 171 deletions.
12 changes: 8 additions & 4 deletions DEV_README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

<b>`** v13.0.0 **`</b>

<p>In this version our team focused on refactoring the broken code base from all previous versions. </p>
<p>In this version our team prioritized improving the code base from all prior versions through refactoring. </p>

<p><b> WHAT YOU NEED TO DO FIRST: </b></p>

Expand All @@ -27,7 +27,9 @@ Run npm run dev twice if you do not manually run tsc to compile the files first.

<p><b> WHAT NEEDS TO BE DONE: </b></p>

<p>1. Refractor tableTabBar </p>
<p>1. Refactor tableTabBar Component</p>

- Migrated ERTabling to tableTabBar component to access the ERD because it lacked a parent compartment for prop drilling, hindering the addition of new features. Going forward, a more maintainable solution should be implemented like Redux or Zustand.

- Migrated ERTabling to tableTabBar component to access the ERD because it lacked a parent compartment for prop drilling, hindering the addition of new features. Going forward, a more maintainable solution should be implemented like Redux or Zustand.

Expand All @@ -47,7 +49,7 @@ else (database === DBType.sqlite) {}<br>

<img src="./assets/readmeImages/ERD_before_after.png" height=500/>

<br><br> <b>**_Important_** <br> This is wrtten at backend/src/ipcHandlers/dbCRUDHandlerERD.ts and will replace backend/src/ipcHandlers/dbCRUDHandler.ts when this is ready</b>
<br><br> <b>**_Important_** <br> This is written at backend/src/ipcHandlers/dbCRUDHandlerERD.ts and will replace backend/src/ipcHandlers/dbCRUDHandler.ts when this is ready</b>

<p><b>4. Async event emmiters between front/backend</b></p>
<p>Currently, the way the feedback modal works is by handling events that are emitted from both the frontend and the backend. Ideally, this should be refactored to be state dependent rather than event dependent, as it controls the display of the modal. This can be tied into the centralized async event emitter added to frontend/components/app.tsx, in conjunction with migration to reducers from state variables. The goal will be to house modal messages in the store tied to the main app reducer. From there, the async handler can send new messages to the state via main app dispatch, and any other front end feedback can do the same.<br><br>
Expand All @@ -74,5 +76,7 @@ There are still some filesystem read/write calls in the front end. This should b

<p>5. Foreign and Primary keys.</p>

- Unable to select the primary and/or foreign key of a newly added column until the column is saved onto the database. Once saved onto the database, we can then select the primary and foreign key and save them onto the database.
- Unable to select the primary and/or foreign key of a newly added column until the column is saved onto the database. Once saved onto the database, we can then select the primary and foreign key and save them onto the database.



11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,13 @@ To get started on contributing and editing databases to this project:
- In the 'DATABASES' view, an interactive Entity Relationship Diagram (`ER DIAGRAM`) is displayed for the selected database.
- Users can now save table layout in version 13.

<br>
<div align="center">
<img src="./assets/readmeImages/gifs/save_db_layout.gif" width=800/>
</div>
<br>


- Users can select `TABLE` to see selected database in tabular form.

- Users can select a table from a list of all the tables in the schema of the currently selected database.
Expand Down Expand Up @@ -128,7 +135,7 @@ To get started on contributing and editing databases to this project:

<br>
<div align="center">
<img src="./assets/readmeImages/gifs/create_db3.gif" width=800/>
<img src="./assets/readmeImages/gifs/importCreateDB.gif" width=800/>
<img src="./assets/readmeImages/gifs/modify_db.gif" width=800/>
</div>

Expand All @@ -144,7 +151,7 @@ To get started on contributing and editing databases to this project:
</br>
<br>
<div align="center">
<img src="./assets/readmeImages/gifs/query.gif" width=800/>
<img src="./assets/readmeImages/gifs/querySearch.gif" width=800/>
</div>
<br />

Expand Down
Binary file removed assets/readmeImages/gifs/Manual_Create_DB.gif
Binary file not shown.
Binary file removed assets/readmeImages/gifs/create_db3.gif
Binary file not shown.
Binary file added assets/readmeImages/gifs/importCreateDB.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 removed assets/readmeImages/gifs/query.gif
Binary file not shown.
Binary file added assets/readmeImages/gifs/querySearch.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/readmeImages/gifs/save_db_layout.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 2 additions & 1 deletion backend/src/models/configModel.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
// import path from 'path';
import os from 'os'
import fs from 'fs';
import { DBType, LogType } from '../../../shared/types/dbTypes';
import logger from '../utils/logging/masterlog';
Expand All @@ -8,7 +9,7 @@ import { DocConfigFile } from '../../BE_types';

const home = process.cwd();
const configFile = 'config.json';
const configPath = `${home}/${configFile}`;
const configPath = `${os.homedir()}/Documents/SeeQR/${configFile}`;

// ideally, we want to keep this config in a seperate file as well
export const defaultFile: DocConfigFile = {
Expand Down
Loading

0 comments on commit 30484de

Please sign in to comment.