Skip to main content

🗂️ Add Backend Apps

You can use different backend frameworks such as NestJS, ExpressJS, Laravel, Spring Boot, and others.

📋 Guidelines​

  • You can name your backend application(s) with relevant names, like:
    • Examples:
      • nestjs-app for NestJS
      • laravel-app for Laravel
      • expressjs-app for ExpressJS
      • springboot-app for Spring Boot
  • For multiple backend applications, create separate folders inside the apps/ directory with relevant names, like:
    • nest-dashboard-app
    • laravel-auth-app
    • springboot-service-app

Make sure to follow the structure and naming conventions consistently for better maintainability.

📚 Quick Start: Adding Backend Frameworks​

You can follow the detailed documentation provided in this workspace to integrate your preferred backend framework seamlessly.

🔄 Adding Backend Applications to Your Workspace​

We provide boilerplates for various backend frameworks to make your integration process smoother. You can download and add these frameworks to your workspace apps/ folder.

🚀 Available Backend Boilerplates​

Note: Download the repositories as a ZIP file to avoid git reference issues.

🛠️ Updating tsconfig.json​

Ensure that your tsconfig.json in each app extends the base tsconfig from the workspace level for a unified setup.

Example:

{
  "extends": "../../tsconfig.base.json", // Use the correct relative path
  "compilerOptions": {
    // Your existing options
  }
}

🔧 Updating package.json Scripts​

To manage the backend apps easily, update the workspace-level package.json scripts with your actual application names.

Example:

{
  "docker:up": "npm run db:dev:up --workspace=nestjs-app", // Replace 'nestjs-app' with your app name
  "nestjs:dev": "npm run start:dev --workspace=nestjs-app", // Replace 'nestjs-app' with your app name
  "laravel:start": "npm run start --workspace=laravel-app"  // Replace 'laravel-app' with your app name
}

Note: Application name is present in package.json of your backedn application (It's not the folder-name)

📝 Configuring project.json​

  • Ensure that each backend application has its own project.json file configured with necessary scripts and settings.
  • This will allow you to leverage Nx for running your applications effectively from the workspace level.

🚀 Running Your Backend Applications​

Once you've added your backend applications to the workspace, follow these steps to run them:

  1. Install Dependencies: Make sure you are in the workspace (root) level and run:

    $ yarn install
    // or
    $ npm install

  2. Start Docker Services: Run the Docker services needed for your backend by executing:

    npm run docker:up

  3. Provide Necessary Permissions (If you face permission issues): If you encounter permission errors, run the following command to grant necessary permissions:

    sudo chmod -R 777 /{path-to-project-repo}/data/prometheus

  4. Start the Backend Service: Once Docker is up, start your backend service:

    npm run nestjs:dev

  5. Access Swagger & GraphQL:

    • Swagger Docs: Accessible at {BASE_URL}/api
    • GraphQL Playground: Accessible at {BASE_URL}/graphql

Replace {BASE_URL} with your application’s running URL (e.g., http://localhost:3000).

Now your backend apps should be up and running! 🚀