stamler / tybalt Goto Github PK

View Code? Open in Web Editor NEW

0.0 1.0 0.0 9.09 MB

Corporate data and functions in Firebase

License: GNU General Public License v3.0

JavaScript 1.38% HTML 0.07% Vue 32.76% CSS 0.35% TypeScript 61.43% SCSS 2.20% PowerShell 1.58% Jupyter Notebook 0.22%

tybalt's Introduction

tybalt

Corporate time and expense tracking, computer asset management, and reporting in firebase

Send raw login data from the radiator powershell script to the tybalt rawLogins endpoint and have it sorted by user, login, and computer.
Log in to firebase with credentials presented by Azure AD
have employees enter time and bundle time entries into time sheets for approval
have employees submit expenses including receipt attachments
generate reports for invoicing and payroll

install

edit .firebaserc

Set environment variables

firebase functions:config:set tybalt.azureuserautomation.secret="COMPANYAzureTenant secret" 
firebase functions:config:set tybalt.wireguard.secret="WireGuard server secret" 
firebase functions:config:set tybalt.radiator.secret="tybalt secret"
firebase functions:config:set tybalt.openai.key="openai key"

firebase functions:config:set algolia.apikey="algolia key with addObject and deleteObject permission"
firebase functions:config:set algolia.appid="algolia app id"

firebase functions:config:set mysql.host="mysql hostname"
firebase functions:config:set mysql.port="mysql port number"
firebase functions:config:set mysql.user="mysql username"
firebase functions:config:set mysql.pass="mysql password"
firebase functions:config:set mysql.db="mysql database"

firebase functions:config:set mysqlSSH.host="mysql ssh tunnel hostname"
firebase functions:config:set mysqlSSH.port="mysql ssh tunnel port number"
firebase functions:config:set mysqlSSH.user="mysql ssh tunnel username"
firebase functions:config:set mysqlSSH.pass="mysql ssh tunnel password"

Setup credential in Azure Automation account with username COMPANYAzureTenant and secret matching the secret in step 2. This is used for dumping AD to Tybalt cloud function.
Setup the "Trigger Email" extension in firebase. The email documents collection is Emails and the users collection is Profiles. Also set an appropriate FROM address and SMTP connection URI.
rename config.ts.template to config.ts and set the required values.
Add the Variables in the Automation account in Azure. Variables are in Execute-UserMutations.ps1 and Dump-ADUsersToTybalt.ps1
firebase deploy

tybalt's People

Contributors

Watchers

tybalt's Issues

Refactor List components

Switching to mobile-friendly individual List components creates a lot of duplicate code. Most of this can be implemented in a new MobileList.vue component with a slot template.

Personal Mileage claims show reimbursement rate of $0/km on first entry of the year

The getMileageRate() function in ExpensesEdit.vue returns 0 if the mileageClaimed property is undefined on the Profile document. The getMileageRate() function should instead assume that this is the first tier and return the corresponding first-tier value.

Validate permissions model on UI

Ensure that the UI reflects the rights that a user actually has in firestore rules and functions.

Enhance test suite to use firebase/testing

One bug 1786 is fixed, refactor the sinon stubs to use the firebase/testing SDK

Store custom claims in database rather than auth

Currently Profiles exports data from firebase Auth and is not the source of Authority. Examine the possibility of using Profiles as the source of role authority then writing custom claims from profiles as tokens are minted.

Error reporting to user in UI

Often rejected promises write to the console. This needs to be updated to the UI

TimeEntries Project Typeahead

Create an auto-complete module so that creating / editing a TimeEntry provides typeahead when entering project from the database.

Planned Implementation:

Create an onWrite() firestore trigger on Projects collection
functions.firestore.document('Projects/{projectId}').onWrite(updateSearchString);
Write the updateSearchString() function which takes string value from specific properties and tokenizes them then adds the tokens to a searchStrings array property.
Create the Typeahead field which tokenizes the input the same way that the backend does then provides each token to a where() query:
.where('searchStrings', 'array-contains', token1). NB that firestore does not support chained array-contains queries so a separate query needs to be performed for each search term(!) and then ANDed together with the others to find the intersect. This can be done on the client side or in a cloud function. a stackoverflow answer explanation

Alternative Simple implementation (search project number only)

Create test suite for firestore rules

There is currently no testing for firestore rules. These need to be validated prior to deployment

Scroll-under nav bar with hidden search input

Make the nav bar fixed and scroll content under it. Make the search input begin under the nav bar and pull down to search.

Update README

README is very outdated. Update it to document installation and deployment procedures as well as technical information about the frontend, backend, and code layout.

Fix Edit Components for Mobile

Editing for Projects, Divisions, and TimeTypes doesn't work properly on mobile. Model them after the Editor for TimeEntries.

Sort UserMutations docs by date in descending order

With many mutations it can become difficult to identify the important ones. Sort the mutations by statusUpdated timestamp in descending order so that the most recently changed mutations appear at the top of the list.

Further, UserMutations with a status of complete should appear at the bottom while all others statuses should appear above. Thus it's a double sorting, grouping first by status of either complete or not complete then sorting by statusUpdated within each group.

Implement Timesheets Bundle button

User should be able to click the bundle button and all TimeEntries from a given week will be validated and bundled into a TimeSheet document which contains TimeEntries and extra metadata. This will be ready for submission.

Implement profile editing on mobile

After updating ProfileList for mobile, it's no longer possible to ModClaims on the app.