Workspace (To be renamed)

---

A working environment for the Home-Lab.

[!INFO] Workspace is in need of a permanent name, any suggestions would be appreciated in the discord.

Warning

Workspaces is not yet intended for production use. Although early adoption for testing purposes is appreciated.

Links

• Discord -> https://discord.gg/jcJeGEAYhY
• Source Code (GitHub) -> https://github.com/tricolorsoftware/workspaces

Showcase

View Screenshots

Login Page

Signup Page

App Navigation Rail

Dashboard

Files Grid

Settings Profile Page (Mobile mode)

Settings Overview Page

Settings Customize Wallpaper Page

Store Application Page

Installation Guide for Development Environments

---

Tip

If you are struggling with the following instructions, please ask for help in the project's discord server which can be found in the links section.

Dependencies

Dependency	NPM Package	External Installation Guide	Optional
Bun		https://bun.sh	No
PostgreSQL		https://www.postgresql.org/	No

Important

Please ensure all non-optional dependencies are installed before proceeding.

1. Ensure all non-NPM dependencies are installed
   • Ubuntu Linux
     1. Install PostgreSQL -> sudo apt install postgresql postgresql-contrib
     2. Start the PostgreSQL service -> sudo systemctl enable --now postgresql
     3. Switch to the postgres user -> sudo su postgres
     4. Open PostgreSQL with psql -> psql
     5. Create a PostgreSQL database with the following query -> CREATE DATABASE tricolor_workspaces;
     6. Change the PostgreSQL password with the following query -> ALTER USER postgres WITH PASSWORD 'postgres';
     7. Exit psql -> exit;
     8. Logout from the postgres user -> exit
   • Windows
     1. Simply install postgreSQL with the setup file downloaded from the postgreSQL website
     2. Open your database viewer of choice (DBeaver Community Edition is recommended)
     3. Create the tricolor_workspaces table
   • MacOS
     1. Using Orbstack with Ubuntu follow the Ubuntu Linux instructions above
2. Run bun install inside the project root directory to install all NPM dependencies
3. Run bun run dev to start up the web interface and backend in development mode