DOCSEARCHbyAlgolia
Submit Docs

Stablocks Documentation

website·Indexed 30 days ago

https://learn.stablocks.com

Documentation for Stablocks, an open-source modular platform. Includes guides on setup and installation, developer introductions, and detailed module documentation for Essentials, CRM, Finance, Human Resources, Project Management, Marketing, and Sales.

Tokens
1.9K
Snippets
3
Records
31
Agent score
50%

What's inside Stablocks

  1. Overview of Stablocks business management platform

    Stablocks is an all-in-one business management solution designed for freelancers, bootstrapped startups, and small businesses. It aims to replace the need for multiple fragmented SaaS products (such as separate tools for invoicing, project management, recruiting, and CRM) by providing a consolidated system that focuses on the core 20% of features that deliver 80% of the results.

  2. Manage employee access using Roles

    Roles in Stablocks are used to refine the specific modules and actions that employees can access. These roles are managed and assigned to employees by users with Administrator privileges.

  3. Understand User Types in Stablocks

    User types provide broad classifications for users within the system. They serve as a high-level categorization, whereas roles are used to create more granular permissions specifically for employees. There are three available user types: External, Employee, and Admin.

  5. Contribute to the Stablocks open-source project

    Stablocks is an open-source project that encourages developer contributions via its main GitHub repository. Developers can participate by reporting issues, submitting pull requests, or engaging in the discussions section to help improve the project.
    Main Repository: https://github.com/stablocks/stablocks

  6. Contribute to Stablocks developer documentation

    The Stablocks developer documentation is open for community improvements. If you find mistakes or unclear sections, you can contribute by opening an issue or submitting a pull request to the documentation repository.
    Docs Repository: https://github.com/stablocks/learn

  7. Create a Supabase project for Stablocks

    To set up the database for Stablocks, create a new project at app.supabase.io using a GitHub account. During project creation, you must provide a project name, a strong database password (which must be saved for later use), and select a region closest to your users. The Free Tier is sufficient for initial setup.

  8. Configure Supabase for Stablocks

    Supabase serves as the database and authentication layer for Stablocks. To set it up:

    1. Create a new project at Supabase.
    2. Navigate to Authentication > Configuration > Settings and add your website URL.
    3. Ensure Enable Email Signup is checked and Disable Signup is unchecked.

  9. Configure Third-Party SSO in Supabase

    To enable single sign-on (SSO) for employees using Google or Azure (Microsoft):

    1. Obtain the necessary third-party credentials from the provider (Google or Azure).
    2. In the Supabase dashboard, go to Authentication > Settings > External OAuth Providers and add the credentials.

  11. Configure Supabase Authentication for Stablocks

    To enable user logins for a Stablocks installation, navigate to Authentication > Configuration > Settings in the Supabase dashboard and apply the following settings:

    1. Site URL: Set this to the final URL of your Stablocks installation (e.g., https://stablocks.company.com).
    2. Disable Signup: Ensure this is unchecked.
    3. Enable Email Signup: Ensure this is checked to allow email-based logins.

    Stablocks uses passwordless authentication by default, sending login links to users' emails. Optionally, enable Enable email confirmations for additional security.

  12. Retrieve Supabase connection variables for Stablocks deployment

    Stablocks requires specific environment variables to connect to Supabase. These are found under the Settings (gear icon) menu in the Supabase dashboard:

    • DATABASE_URL: Go to Settings > Database, scroll to the Connection string section, select the Nodejs tab, and append your database password to the string.
    • SUPABASE_KEY: Go to Settings > API and copy the anon/public key from the Project API keys section.
    • SUPABASE_URL: Go to Settings > API and copy the URL from the Configuration section.
    • SUPABASE_JWT_SECRET: Go to Settings > API and copy the JWT Secret from the Configuration section.
    # Example DATABASE_URL format
postgresql://postgres:PaSsWoRd@db.abcdefghijklmnopqrst.supabase.co:5432/postgres