Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Develop #498

Merged
merged 318 commits into from
Jan 21, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
318 commits
Select commit Hold shift + click to select a range
d41ff4d
Merge pull request #416 from bluewave-labs/creating-helper-link-in-js…
erenfn Dec 25, 2024
f389418
Merge pull request #425 from MandeepPaul/fix/#367-spacing/padding-iss…
erenfn Dec 25, 2024
e0cc17c
Merge pull request #433 from bluewave-labs/fix/#428-changing-target-l…
erenfn Dec 25, 2024
3df0938
Fixed the issues discussed in the meeting
erenfn Dec 25, 2024
444e6dc
update helperlink fieldname
swoopertr Dec 26, 2024
bbcddcf
actions parameter text fix
swoopertr Dec 26, 2024
dc167f7
Merge pull request #430 from bluewave-labs/refactor-mui-root
swoopertr Dec 26, 2024
6a34ff8
Merge pull request #435 from bluewave-labs/after-meeting-fixes
swoopertr Dec 26, 2024
4bfe73b
active tab highlight fix
MandeepPaul Dec 26, 2024
cc64f20
fixed typo
erenfn Dec 26, 2024
1f54ebb
Merge branch 'develop' into add-url-to-hint
erenfn Dec 26, 2024
4ae68b3
Merge branch 'develop' into text-field-erros-fixed
erenfn Dec 26, 2024
e5a1d23
Merge pull request #436 from bluewave-labs/fix/#409-sidebar-active-it…
erenfn Dec 26, 2024
d5c29cd
settings styles fixed
erenfn Dec 26, 2024
3f8f697
Merge pull request #438 from bluewave-labs/settings-style-fix
erenfn Dec 26, 2024
c08dea5
Merge branch 'add-url-to-hint' of https://github.com/bluewave-labs/bl…
erenfn Dec 26, 2024
e901be0
added Op to imports
erenfn Dec 26, 2024
dd30967
fix: add isOpen condition to popup rendering
DeboraSerra Dec 26, 2024
af83188
Merge branch '410-dialog-reset' of github.com:bluewave-labs/bluewave-…
DeboraSerra Dec 26, 2024
3b06c69
Merge branch 'develop' of github.com:bluewave-labs/bluewave-onboardin…
DeboraSerra Dec 26, 2024
6163206
fix: fix merge errors
DeboraSerra Dec 26, 2024
aaa9ccd
Merge branch 'develop' into creating-banner-script-in-jsAgent
swoopertr Dec 28, 2024
645d2bc
changed default scrollbar style
MandeepPaul Dec 28, 2024
0d4f4dc
Merge pull request #440 from bluewave-labs/fix/#402-scrollbar-change
erenfn Dec 28, 2024
4e020ed
Merge pull request #429 from bluewave-labs/410-dialog-reset
erenfn Dec 28, 2024
e804743
added relevant cahnges to hint too
erenfn Dec 28, 2024
25077b9
Merge pull request #441 from bluewave-labs/410-dialog-reset
erenfn Dec 28, 2024
076348c
Changed Bluewave Onboarding to GuideFox
erenfn Dec 28, 2024
5de05ef
feat: add express validation to POST /set-organisation
DeboraSerra Dec 28, 2024
5d2e81c
feat: add express validation to POST /team/invite
DeboraSerra Dec 28, 2024
baf3695
feat: add express validation to PUT /team/change-role
DeboraSerra Dec 28, 2024
4d68dee
feat: add express validation to PUT /team/server-url
DeboraSerra Dec 28, 2024
3c1f876
feat: add express validation to DELETE /team/remove/:memberId
DeboraSerra Dec 28, 2024
69c4cd1
refactoring
swoopertr Dec 28, 2024
3762aab
Merge pull request #442 from bluewave-labs/410-dialog-reset
swoopertr Dec 28, 2024
0f0bfb4
fix: fix tests
DeboraSerra Dec 28, 2024
6e0e450
Merge pull request #431 from bluewave-labs/add-url-to-hint
swoopertr Dec 28, 2024
ec9cde8
Merge pull request #423 from bluewave-labs/text-field-erros-fixed
swoopertr Dec 28, 2024
275ea0d
Merge branch 'develop' into creating-banner-script-in-jsAgent
swoopertr Dec 28, 2024
7dd4a4f
Update LogoStyles.module.css
erenfn Dec 29, 2024
dcb99e0
Update Login.module.css
erenfn Dec 29, 2024
d82d93f
removed "Creator" from all the returned responses
MandeepPaul Dec 30, 2024
43a87d4
feat: add validations to link
DeboraSerra Dec 30, 2024
f9f848c
feat: pass validations to route and clean controller
DeboraSerra Dec 30, 2024
88ea1da
chore: update postman requests
DeboraSerra Dec 30, 2024
9748d7c
feat: create helper link validations
DeboraSerra Dec 30, 2024
e1f6a30
feat: pass validations to route and clean controller
DeboraSerra Dec 30, 2024
138787e
chore: update postman requests
DeboraSerra Dec 30, 2024
f074815
test: fix tests to new validations
DeboraSerra Dec 30, 2024
26dd257
fix: add coderabbit fixes
DeboraSerra Dec 30, 2024
9e81bbd
fix: remove unused functions from helperLink
DeboraSerra Dec 30, 2024
62d7681
tuning boxes for variety of different pages
swoopertr Dec 30, 2024
cc2aad0
last touches
swoopertr Dec 31, 2024
a9496b0
fix: change error treatment on link
DeboraSerra Dec 31, 2024
8b81ba0
Set the container to stretch fully to maintain consistency.
MandeepPaul Jan 2, 2025
76080a3
fixed mui design popup
MandeepPaul Jan 2, 2025
8ee575b
refactored design popup design
MandeepPaul Jan 2, 2025
407e5db
Merge pull request #443 from bluewave-labs/392-refactoring-validation…
erenfn Jan 2, 2025
246bcb2
Fixed settings page layout
MandeepPaul Jan 2, 2025
7d55839
Bug fix
MandeepPaul Jan 2, 2025
3261688
Merge branch 'develop' of github.com:bluewave-labs/bluewave-onboardin…
DeboraSerra Jan 2, 2025
66ab029
feat: create decode function
DeboraSerra Jan 2, 2025
8f9d89b
feat: add function to auth and user
DeboraSerra Jan 2, 2025
f6e34fe
docs: remove he package
DeboraSerra Jan 2, 2025
c8da222
fix: add try/catch to decode and update test
DeboraSerra Jan 2, 2025
603e66a
fix: fix picture validation
DeboraSerra Jan 2, 2025
a829f39
fix: fix picture validation
DeboraSerra Jan 2, 2025
c53949c
Merge pull request #454 from bluewave-labs/365-replace-he-package-and…
erenfn Jan 2, 2025
296a4fd
Merge pull request #448 from bluewave-labs/390-refactoring-validation…
erenfn Jan 2, 2025
8393d33
changed tests
erenfn Jan 2, 2025
ace8fc9
Merge branch 'develop' of https://github.com/bluewave-labs/bluewave-o…
erenfn Jan 2, 2025
619a6f5
helperlink test fixed
erenfn Jan 2, 2025
3255540
Merge pull request #447 from bluewave-labs/fix/#432-exclude-creator-f…
MandeepPaul Jan 3, 2025
8750e2d
Merge branch 'develop' into creating-banner-script-in-jsAgent
swoopertr Jan 3, 2025
ca61c9c
local host to db
swoopertr Jan 3, 2025
68de115
Fixed fontSize on confirmation popup
MandeepPaul Jan 3, 2025
84f2039
Merge pull request #449 from bluewave-labs/creating-banner-script-in-…
erenfn Jan 3, 2025
5c1d14e
add base url to backend
erenfn Jan 3, 2025
24e0b67
fixed edit for hints
erenfn Jan 3, 2025
636b79c
Changed fixed width to dynamic width
MandeepPaul Jan 3, 2025
6b2fd2c
feat: add validation to link settings
DeboraSerra Jan 3, 2025
23e0c51
feat; add formik to appearance form
DeboraSerra Jan 3, 2025
0e4a9df
chore: cleanup code
DeboraSerra Jan 3, 2025
a6bb9ef
fix: fix not defined error
DeboraSerra Jan 3, 2025
39cd122
test: fix tests
DeboraSerra Jan 3, 2025
5cdc70f
chore: create ColorInput component
DeboraSerra Jan 3, 2025
034b0df
feat: update className on colorInput
DeboraSerra Jan 3, 2025
ddc73a1
Merge pull request #453 from bluewave-labs/452-ui-improvements
erenfn Jan 3, 2025
70d1ddb
Merge pull request #462 from bluewave-labs/hint-edit-fix
swoopertr Jan 4, 2025
72ea652
Added reusable PopupMessageDialog
MandeepPaul Jan 4, 2025
45ee59b
Refactored ConfirmationPopup to PopUpMessages wrapper
MandeepPaul Jan 4, 2025
32213c7
Refactored LinkDialog to PopUpMessages wrapper
MandeepPaul Jan 4, 2025
005e4b6
Refactored DeleteConfirmationModal to PopUpMessages wrapper
MandeepPaul Jan 4, 2025
3701e2c
Removed redundant styles
MandeepPaul Jan 4, 2025
b35ca55
redefined contentText style reference
MandeepPaul Jan 4, 2025
5dd0819
chore: update header validation
DeboraSerra Jan 4, 2025
a2e050c
chore: change moment of validation
DeboraSerra Jan 4, 2025
0516005
chore: update error message style
DeboraSerra Jan 4, 2025
d6cc068
Merge pull request #464 from bluewave-labs/434-create-a-custom-compon…
erenfn Jan 4, 2025
da02c93
fixed baseUrl vs agentUrl
erenfn Jan 4, 2025
e779298
fixed baseUrl vs agentUrl 2
erenfn Jan 4, 2025
84b6a9c
chore: remove length validation from header
DeboraSerra Jan 4, 2025
c0fd8aa
Merge pull request #463 from bluewave-labs/458-formik-and-yup-validat…
erenfn Jan 5, 2025
f597636
adding hint.js
swoopertr Jan 5, 2025
085edc1
Merge branch 'develop' into creating-hint-in-jsAgent
swoopertr Jan 5, 2025
edf6ace
adding content, header and button
swoopertr Jan 5, 2025
59a7579
docs: update comments on development env
DeboraSerra Jan 6, 2025
e467b01
docs: update comments on test env
DeboraSerra Jan 6, 2025
6bc5b5c
docs: update variables and add comments on prod env
DeboraSerra Jan 6, 2025
bed19c5
docs: update readme
DeboraSerra Jan 6, 2025
859470f
docs: update with coderabbit suggestions
DeboraSerra Jan 6, 2025
27b7184
docs: add test variables to .rnv
DeboraSerra Jan 6, 2025
5d6736b
chore: update config to different .env files
DeboraSerra Jan 6, 2025
5c6a66d
chore: remove test var from dev .env
DeboraSerra Jan 6, 2025
1e53cc1
Update README.md
erenfn Jan 6, 2025
a6e024c
chore: update scripts
DeboraSerra Jan 6, 2025
9e77c7b
Merge branch '459-add-definitions-for-important-env-variables-to-read…
DeboraSerra Jan 6, 2025
3d2aaba
docs: add psql check to script
DeboraSerra Jan 6, 2025
454ca17
docs: fix script logic
DeboraSerra Jan 6, 2025
31346da
refactor: streamline tooltip content generation and enhance button fu…
swoopertr Jan 7, 2025
16ddb1f
delete: remove unused tooltip example HTML file
swoopertr Jan 7, 2025
fedc125
fix: update database host in environment configuration
swoopertr Jan 7, 2025
024adfe
fix: correct variable assignment for tooltip position timer
swoopertr Jan 7, 2025
9ed8c8c
Added 'Duplicate' button to create a copy of a guide.
MandeepPaul Jan 7, 2025
c3444e2
Add state to trigger re-render when a guide is duplicated.
MandeepPaul Jan 7, 2025
e9b4990
Changed Icon type and message style.
MandeepPaul Jan 7, 2025
77d4926
Bug fix
MandeepPaul Jan 7, 2025
839c419
docs: update pretest script
DeboraSerra Jan 7, 2025
50fb7dc
Merge pull request #471 from bluewave-labs/466-add-duplicate-button
erenfn Jan 7, 2025
8268af2
Fixed 'ListItem' icons
MandeepPaul Jan 7, 2025
92631ae
Matched the font size and color to the theme
MandeepPaul Jan 7, 2025
90fd96e
SVG file name updated
MandeepPaul Jan 7, 2025
b5c3d63
Rename utility-icons.jsx to utilityIcons.jsx
erenfn Jan 7, 2025
4ea59a3
Update ListItem.jsx
erenfn Jan 7, 2025
a2a5c0e
fix: adjust font sizes and improve button shadow effects in modal
swoopertr Jan 7, 2025
ed8e241
fix: adjust modal button styles and remove unused event listeners
swoopertr Jan 7, 2025
0cbc0f1
fix: remove console.log statements and adjust font sizes in various c…
swoopertr Jan 7, 2025
4af6604
fix: add dynamic positioning to banner component
swoopertr Jan 8, 2025
ac2cef4
fix: improve tooltip button generation and remove unnecessary console…
swoopertr Jan 8, 2025
b3ef754
fix: enhance tooltip functionality with arrow generation and dynamic …
swoopertr Jan 8, 2025
4ba4da9
chore: add error treatment to config
DeboraSerra Jan 8, 2025
8d83a65
Optimized svg component
MandeepPaul Jan 8, 2025
2f75c95
Update utilityIcons.jsx
erenfn Jan 8, 2025
25a64d2
Merge pull request #473 from bluewave-labs/472-fixing-icons
erenfn Jan 8, 2025
c367443
add compression middleware
thomastepi Jan 9, 2025
3abc5e8
Customized BaseSkeleton and added ActivityButton for Hint
MandeepPaul Jan 8, 2025
d666d6f
Updated the button radius to match the value from Figma.
MandeepPaul Jan 8, 2025
96cca8b
Replaced fixed dimensions with percentage-based values for dynamic re…
MandeepPaul Jan 9, 2025
ea4f90e
Corrected the statisticsCards positioning
MandeepPaul Jan 9, 2025
2cee75e
Merge pull request #470 from bluewave-labs/creating-hint-in-jsAgent
swoopertr Jan 9, 2025
b7ca85a
Merge pull request #475 from bluewave-labs/feat/399-add-compression
swoopertr Jan 9, 2025
dd42952
docs: update script
DeboraSerra Jan 10, 2025
45a1174
chore: remove packadge check from script
DeboraSerra Jan 10, 2025
01b741e
Merge pull request #476 from bluewave-labs/474-add-hints-section-to-t…
MandeepPaul Jan 10, 2025
43bb04a
Merge pull request #465 from bluewave-labs/add-base-url-to-backend
erenfn Jan 10, 2025
8c8de56
Fixed syntax errors in utilityIcons.jsx
MandeepPaul Jan 10, 2025
5074b90
Added dropdowns to banner and popup creation pages
MandeepPaul Jan 10, 2025
aaf553f
Implemented server-side validation for repetition field; updated mode…
MandeepPaul Jan 10, 2025
e7bd961
Merge branch 'develop' of github.com:bluewave-labs/bluewave-onboardin…
DeboraSerra Jan 11, 2025
74f54f2
feat: add express-validator to add hint
DeboraSerra Jan 11, 2025
38c8b1f
feat: add express-validator to hint
DeboraSerra Jan 11, 2025
6bbe5ea
Updated tests
MandeepPaul Jan 12, 2025
70a7a36
Update auth.test.mjs
erenfn Jan 12, 2025
08b06ef
Update backend/src/models/Banner.js
erenfn Jan 12, 2025
852bbd9
Update Popup.js
erenfn Jan 12, 2025
b4b11c7
Update frontend/src/scenes/banner/CreateBannerPage.jsx
erenfn Jan 13, 2025
eb59642
Merge pull request #481 from bluewave-labs/477-add-repetition-field-t…
erenfn Jan 13, 2025
4bea8fa
fix invite and reset passwd email service
thomastepi Jan 13, 2025
e17a4bf
some fixes to email and set new password
erenfn Jan 13, 2025
521de77
check email fixes
erenfn Jan 13, 2025
caea6dc
custom link test adjusted
erenfn Jan 13, 2025
717a4a3
Update frontend/src/scenes/login/CheckYourEmailPage.jsx
erenfn Jan 13, 2025
388e84f
ui changes before 1.0
erenfn Jan 13, 2025
5e4470e
handles tokenless case in set new password
erenfn Jan 13, 2025
47b7419
Merge branch '467-fix-email-service' of https://github.com/bluewave-l…
erenfn Jan 13, 2025
d92217b
Merge pull request #484 from bluewave-labs/ui-fixes-before-1.0
erenfn Jan 13, 2025
de8065a
Merge pull request #482 from bluewave-labs/467-fix-email-service
erenfn Jan 13, 2025
a0c675e
Update docker-compose.yml
erenfn Jan 13, 2025
032477a
migrations init
erenfn Jan 13, 2025
8477672
Banner backend validation successful
eulerbutcooler Jan 14, 2025
26e198f
Corrected syntax error in CustomTextFieldStyles.css
MandeepPaul Jan 14, 2025
2316a6c
Merge branch 'develop' into 459-add-definitions-for-important-env-var…
erenfn Jan 14, 2025
3b93dd0
Changed error messages in banner.test.mjs
eulerbutcooler Jan 14, 2025
e76383f
.env changes
erenfn Jan 14, 2025
1012259
.env changes2
erenfn Jan 14, 2025
b8a4e40
guidelog migration added
erenfn Jan 14, 2025
749311d
Merge branch 'develop' of github.com:bluewave-labs/bluewave-onboardin…
DeboraSerra Jan 14, 2025
f97ad13
chore: fix hint tests
DeboraSerra Jan 14, 2025
f177ef3
Merge pull request #469 from bluewave-labs/459-add-definitions-for-im…
DeboraSerra Jan 14, 2025
bef1003
Merge branch 'develop' of github.com:bluewave-labs/bluewave-onboardin…
DeboraSerra Jan 14, 2025
d565c98
chore: update error treatment on frontend
DeboraSerra Jan 14, 2025
b2b747f
chore: put some of coderabbit suggestions
DeboraSerra Jan 14, 2025
065fa26
organized .env
erenfn Jan 15, 2025
5badd5d
readd compression
erenfn Jan 15, 2025
913234c
Update .env.test
erenfn Jan 15, 2025
8652d6a
Merge pull request #491 from bluewave-labs/459-add-definitions-for-im…
erenfn Jan 15, 2025
354b941
Update config.js
erenfn Jan 15, 2025
15847f2
feat: add url validation
DeboraSerra Jan 15, 2025
90f8c9c
Add migration for helper_link table and refactor guide_logs migration
swoopertr Jan 15, 2025
9b149f1
Add helper_link migration and refactor createdBy field type
swoopertr Jan 15, 2025
104a201
Refactor migration files to standardize table names and rename hint m…
swoopertr Jan 15, 2025
ca47a69
Add migrations for profile pictures, server URL, and action URLs in p…
swoopertr Jan 15, 2025
c153139
Rename migration files for consistency and remove obsolete migrations
swoopertr Jan 15, 2025
34884d4
Update .env
erenfn Jan 15, 2025
6b83a1a
Update docker-compose.yml
erenfn Jan 15, 2025
b079c26
Update README.md
erenfn Jan 15, 2025
43bea92
Refactor migration files to increase string length limits and improve…
swoopertr Jan 15, 2025
4dcf830
Update Dockerfile and HTML title, add menu icon color, and modify ema…
swoopertr Jan 15, 2025
4bec64f
Fix typo in visibility property in hint.js
swoopertr Jan 15, 2025
694f824
Add default values for headerBackgroundColor, linkFontColor, and icon…
swoopertr Jan 15, 2025
3a8d84d
Fix comment in migration file to accurately reflect table being dropped
swoopertr Jan 15, 2025
66c14ac
refactor: refactor validator with coderabbit sugestion
DeboraSerra Jan 15, 2025
b563ab6
Fix bug that was breaking the editor/preview buttons in createPopupPage
MandeepPaul Jan 15, 2025
036d213
Fixed button position on HintPage as well
MandeepPaul Jan 15, 2025
219883a
Update auth.test.mjs
MandeepPaul Jan 15, 2025
ba010be
chore: update hist tests
DeboraSerra Jan 15, 2025
33cb1b7
chore: remove .only from test
DeboraSerra Jan 15, 2025
3dc01fa
Merge branch 'develop' of github.com:bluewave-labs/bluewave-onboardin…
DeboraSerra Jan 15, 2025
73008e4
Merge pull request #489 from bluewave-labs/486-vite-and-vite-preview-…
erenfn Jan 16, 2025
1f4d8a5
Merge branch 'develop' into 389-refactoring-validations-in-hint-route…
erenfn Jan 16, 2025
b4b2401
Merge pull request #490 from bluewave-labs/389-refactoring-validation…
erenfn Jan 16, 2025
81bc2d7
Update README.md
erenfn Jan 16, 2025
e60b057
Update .env
erenfn Jan 16, 2025
9380551
Update README.md
erenfn Jan 16, 2025
97291b9
Modified the tests for banners. All tests passing.
eulerbutcooler Jan 16, 2025
eb131e5
merged the develop branch
eulerbutcooler Jan 16, 2025
4c7285f
Added CodeRabbitAI suggestions
eulerbutcooler Jan 16, 2025
abb3929
Update README.md
erenfn Jan 16, 2025
b27e268
fixed migrations
erenfn Jan 16, 2025
fb94b44
Merge branch 'master' into develop
erenfn Jan 16, 2025
f763790
Update .env
erenfn Jan 16, 2025
fd9a033
Update Dockerfile
erenfn Jan 17, 2025
5b7778d
Update Dockerfile
erenfn Jan 17, 2025
2d5ca7f
Update .env
erenfn Jan 17, 2025
2682fd0
Update docker-compose.yml
erenfn Jan 17, 2025
8f7340d
Update .env
erenfn Jan 17, 2025
c8d5269
Add z-index to hint.js for improved layering
swoopertr Jan 17, 2025
27fd9f9
Merge branch 'rewrite-migrations' of https://github.com/bluewave-labs…
swoopertr Jan 17, 2025
a1f093d
feat: add formik to hint content
DeboraSerra Jan 17, 2025
6229878
Singular error text for repetition type
eulerbutcooler Jan 17, 2025
de3e4f4
Merge branch 'develop' of https://github.com/bluewave-labs/guidefox i…
eulerbutcooler Jan 17, 2025
937a789
Update package.json
erenfn Jan 17, 2025
0e1407d
Merge branch 'develop' of https://github.com/bluewave-labs/guidefox i…
eulerbutcooler Jan 17, 2025
c162d1c
Added tests for repetitionType and fixed its validation
eulerbutcooler Jan 17, 2025
fbcd7c2
Merge pull request #497 from eulerbutcooler/banner-validation
erenfn Jan 17, 2025
9ae38b9
Merge branch 'develop' into rewrite-migrations
erenfn Jan 17, 2025
5c31027
Merge pull request #493 from bluewave-labs/rewrite-migrations
erenfn Jan 17, 2025
cd7cca1
Update README.md
erenfn Jan 17, 2025
de9b01f
feat: add formik to hint appearence
DeboraSerra Jan 17, 2025
999fa03
Merge pull request #499 from bluewave-labs/457-formik-and-yup-validat…
erenfn Jan 20, 2025
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
22 changes: 5 additions & 17 deletions .env
Original file line number Diff line number Diff line change
@@ -1,19 +1,7 @@
# Development Environment Configuration
NODE_ENV=development
PORT=3000
# Database Configuration
DEV_DB_USERNAME=user123
DEV_DB_PASSWORD=password123
DEV_DB_NAME=onboarding_db
DEV_DB_HOST=localhost
DEV_DB_PORT=5432
NODE_ENV=production

# JWT Secret Key
JWT_SECRET="NKrbO2lpCsOpVAlqAPsjZ0tZXzIoKru7gAmYZ7XlHn0=qqwqeq"

[email protected]
EMAIL_PASSWORD=passwor
EMAIL_HOST=smtp.gmail.com
EMAIL_PORT=465
APP_PASSWORD=password
EMAIL_ENABLE=false
# Used in docker-compose.yml db
POSTGRES_USER=user123
POSTGRES_PASSWORD=password123
POSTGRES_DB=onboarding_db
176 changes: 154 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,16 +20,32 @@ The source code is available under GNU AGPLv3. If you would like to support us,

![guidefox](https://github.com/user-attachments/assets/46d912c9-339a-4044-979b-338557f28949)


## Tech stack

- [ReactJs](https://react.dev/)
- [MUI (React framework)](https://mui.com/)
- [Node.js](https://nodejs.org/en)
- [PostgreSQL](https://postgresql.org)

## For Local Use

Make sure docker and git is installed

1. Clone the project

`git clone https://github.com/bluewave-labs/guidefox.git`

2. Navigate to the project directory

`cd guidefox`

3. Run docker

`docker compose build`

## Installation
`docker compose up`

## Server Installation

1. Make sure Docker is installed to your machine where the server will run.
2. Make sure git is installed to your machine Git.
Expand All @@ -47,24 +63,15 @@ cd bluewave-onboarding

Open the Nginx configuration file:

``sudo nano /etc/nginx/sites-available/guidefox``
`sudo nano /etc/nginx/sites-available/guidefox`


Add the following configuration. Change YOUR_DOMAIN_NAME with your domain name:

```
server {
listen 80;
server_name YOUR_DOMAIN_NAME;
return 301 https://$host$request_uri;
}

server {
listen 443 ssl;
server_name YOUR_DOMAIN_NAME;
ssl_certificate /etc/letsencrypt/live/YOUR_DOMAIN_NAME/fullchain.pem;
ssl_certificate_key /etc/letsencrypt/live/YOUR_DOMAIN_NAME/privkey.pem;
include /etc/letsencrypt/options-ssl-nginx.conf;
ssl_dhparam /etc/letsencrypt/ssl-dhparams.pem;

location / {
proxy_pass http://localhost:4173; # Frontend React app
Expand Down Expand Up @@ -92,31 +99,157 @@ server {
}
```


6. Create a symbolic link to enable the configuration:

``sudo ln -s /etc/nginx/sites-available/guidefox /etc/nginx/sites-enabled/``
`sudo ln -s /etc/nginx/sites-available/guidefox /etc/nginx/sites-enabled/`

7. Install Certbot and its Nginx plugin:

``sudo apt install certbot python3-certbot-nginx``
`sudo apt install certbot python3-certbot-nginx`

Make sure you have `/etc/letsencrypt/options-ssl-nginx.conf` If not you can get it from https://raw.githubusercontent.com/certbot/certbot/master/certbot-nginx/certbot_nginx/_internal/tls_configs/options-ssl-nginx.conf

8. Obtain SSL Certificate. Run Certbot to obtain a certificate for your domain:

``sudo certbot --nginx``
`sudo certbot --nginx`

9. Verify the Nginx configuration:

``sudo nginx -t``
`sudo nginx -t`

10. Restart Nginx to apply the changes:

``sudo systemctl restart nginx``
`sudo systemctl restart nginx`

11. Start the project

``cd ~/guidefox
docker compose up -d``
`cd ~/guidefox
docker compose up -d`

## Environment variables

In order to the project to run safely and correctly, the user should add their own environment variables. They can be added to the .env file in the backend directory of the project. The following is the list of environment variables that should be added and its description:

1. Node Env

```env
NODE_ENV - node environment (production, test or development)
```

It is set from the .env file in the root directory

2. Api Url

```
API_BASE_URL - Backend API url
```

It is set from ./frontend/src/utils/constant.js

3. Database credentials

In the root folder

```env
POSTGRES_USER - Database username (The same as DB_USERNAME)
POSTGRES_PASSWORD -Database password (The same as DB_PASSWORD)
POSTGRES_DB - Database name (The same as DB_NAME)
```

In the backend folder

```env
DB_USERNAME - Database username
DB_PASSWORD - Database password
DB_NAME - Database name
DB_HOST - Database host
DB_PORT - Database port
TEST_DB_USERNAME - Test database username
TEST_DB_PASSWORD - Test database password
TEST_DB_NAME - Test database name
TEST_DB_HOST - Test database host
TEST_DB_PORT - Test database port
```

4. Email service configuration
For the email service to run correctly, the user should add their own email credentials

```env
EMAIL_ENABLE - Enable email service (boolean)
EMAIL_HOST - Email host
EMAIL_PORT - Email port
EMAIL - Email
APP_PASSWORD - Email password
FRONTEND_URL - Url of the frontend server
```

Example configuration:

```env
EMAIL_ENABLE=true
EMAIL_HOST=smtp.gmail.com
EMAIL_PORT=587
[email protected]
APP_PASSWORD=your-app-specific-password
FRONTEND_URL=https://www.frontendserver.com
```

Note: When using Gmail, you'll need to enable 2-factor authentication and generate an App Password.

5. JWT Secret Key

```env
JWT_SECRET - secret key to sign the JWT token
```

- Use a strong, random secret key (minimum 32 characters)

6. Enable IP check for the API
If the ENABLE_IP_CHECK is set to true, but the ALLOWED_IP_RANGE and ALLOWED_IPS are not set, the API will work for all IP addresses.

```env
ENABLE_IP_CHECK - Enable IP check for the API (boolean)
ALLOWED_IP_RANGE - Allowed IP range for the API with the format "baseIp/rangeStart-rangeEnd" (e.g. 192.168.1/1-255) separated by comma
ALLOWED_IPS - Allowed IP addresses for the API separated by comma
```

Example configuration:

```env
ENABLE_IP_CHECK=true
ALLOWED_IP_RANGE=192.168.1/1-255,10.0.0/1-100
ALLOWED_IPS=203.0.113.1,203.0.113.2
```

Note: For security reasons, it's recommended to always set either ALLOWED_IP_RANGE or ALLOWED_IPS when ENABLE_IP_CHECK is true.

7. In .env.test file, the user should have the following environment variables, so the postgres container can run correctly:

```env
POSTGRES_USER - Test database username (The same as TEST_DB_USERNAME)
POSTGRES_PASSWORD - Test database password (The same as TEST_DB_PASSWORD)
POSTGRES_DB - Test database name (The same as TEST_DB_NAME)
```

For running tests in windows installing `win-node-env` module is recommended

## Showing guides on the screen

After setting up the project, copy and paste the script that can be found in the Code tab of the Settings. Modify Api Base URL to point out to the url of tour backend server. The code snippet can also be found here:

`
window.bwApiBaseUrl = 'https://guidefox-demo.bluewavelabs.ca/api/';
window.bwAgentBaseUrl = 'https://cdn.jsdelivr.net/gh/bluewave-labs/[email protected]/jsAgent/';

var s=document.createElement("script");
s.type="text/javascript";
s.async=false;
s.onerror=()=>{console.log("onboard not loaded");};
s.src = window.bwAgentBaseUrl + '/main.js';
(document.getElementsByTagName("head")[0] || document.getElementsByTagName("body")[0]).appendChild(s);
`

We are working on a browser extention to move this code there to improve the user experience.

## Contributing

Expand All @@ -141,4 +274,3 @@ Also check other developer and contributor-friendly projects of BlueWave:
- [BlueWave HRM](https://github.com/bluewave-labs/bluewave-hrm), a complete Human Resource Management platform.
- [VerifyWise](https://github.com/bluewave-labs/verifywise), the first open source AI governance platform.


39 changes: 20 additions & 19 deletions backend/.env
Original file line number Diff line number Diff line change
@@ -1,26 +1,27 @@
# Node environment
NODE_ENV=development
# For development environment, the project is ready to run after cloning and installing the dependencies.
# Development database environment
DB_USERNAME=user123
DB_PASSWORD=password123
DB_NAME=onboarding_db
DB_HOST=db
DB_PORT=5432

# Development environment
DEV_DB_USERNAME=user123
DEV_DB_PASSWORD=password123
DEV_DB_NAME=onboarding_db
DEV_DB_HOST=db
DEV_DB_PORT=5432

EMAIL_ENABLE=false

# JWT Secret Key
JWT_SECRET="NKrbO2lpCsOpVAlqAPsjZ0tZXzIoKru7gAmYZ7XlHn0=qqwqeq"

TEST_DB_USERNAME=user123
TEST_DB_PASSWORD=password123
TEST_DB_NAME=onboarding_db_test
TEST_DB_HOST=localhost
TEST_DB_PORT=5432
[email protected]
EMAIL_PASSWORD=passwor
EMAIL_HOST=smtp.gmail.com
EMAIL_PORT=465
APP_PASSWORD=ukzwakckupguegiw
EMAIL_ENABLE=true

# Enable IP check for the API
ENABLE_IP_CHECK=false
# Allowed IP range for the API "baseIp/rangeStart-rangeEnd" (e.g. 192.168.1/1-255) separated by comma
ALLOWED_IP_RANGE=11.22.33/10-200, 192.168.65/1-255
# Allowed IP addresses for the API separated by comma
ALLOWED_IPS=127.0.0.1, 11.22.33.44, 11.22.33.45, 11.22.33.46, 192.168.65.1

# FRONTEND_URL=https://onboarding-demo.bluewavelabs.ca/
FRONTEND_URL=http://localhost:4173/

# JWT secret for running npm run dev in backend folder locally
JWT_SECRET="NKrbO2lpCsOpVAlqAPsjZ0tZXzIoKru7gAmYZ7XlHn0=qqwqeq"
17 changes: 0 additions & 17 deletions backend/.env.production

This file was deleted.

19 changes: 5 additions & 14 deletions backend/.env.test
Original file line number Diff line number Diff line change
@@ -1,21 +1,12 @@
# Test Environment Configuration

# Database Configuration
POSTGRES_USER=user123
POSTGRES_PASSWORD=password123
POSTGRES_DB=onboarding_db_test

TEST_DB_USERNAME=user123
TEST_DB_PASSWORD=password123
TEST_DB_NAME=onboarding_db_test
TEST_DB_HOST=localhost
TEST_DB_PORT=5432

POSTGRES_USER=user123
POSTGRES_PASSWORD=password123
POSTGRES_DB=onboarding_db_test

# JWT Secret Key
JWT_SECRET=your_test_jwt_secret_key_here

ENABLE_IP_CHECK=false
# Allowed IP range for the API "baseIp/rangeStart-rangeEnd" (e.g. 192.168.1/1-255) separated by comma
ALLOWED_IP_RANGE=11.22.33/10-200, 192.168.65/1-255
# Allowed IP addresses for the API separated by comma
ALLOWED_IPS=127.0.0.1, 11.22.33.44, 11.22.33.45, 11.22.33.46, 192.168.65.1
JWT_SECRET="NKrbO2lpCsOpVAlqAPsjZ0tZXzIoKru7gAmYZ7XlHn0=qqwqeq"
5 changes: 5 additions & 0 deletions backend/.eslintrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"rules": {
"no-unused-vars": "warn"
}
}
10 changes: 10 additions & 0 deletions backend/.prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"trailingComma": "es5",
"semi": true,
"singleQuote": true,
"tabWidth": 2,
"bracketSpacing": true,
"arrowParens": "always",
"singleAttributePerLine": false,
"printWidth": 120
}
2 changes: 1 addition & 1 deletion backend/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@ COPY . .

EXPOSE 3000

CMD if [ "$$NODE_ENV" = "production" ] ; then npm run prod ; elif [ "$$NODE_ENV" = "staging" ] ; then npm run staging ; else npm run dev ; fi
# CMD if [ "$$NODE_ENV" = "production" ] ; then npm run prod ; elif [ "$$NODE_ENV" = "staging" ] ; then npm run staging ; else npm run dev ; fi
Loading
Loading