Skip to main content

🌍 Local Development Setup

✨ This workspace is powered by Nx, Smart Monorepos · Fast CI. ✨

πŸ› οΈ Stack​

  • Backend: NodeJs, NestJs
  • Frontend: VueJs, TailwindCSS with Flowbite

πŸ“‹ Requirements​

To ensure a smooth development experience, please ensure you have the following installed:

  • Node.js: Version 20 or higher
  • TypeScript: Version 5.0.0 or higher
  • NPM: Ensure you have NPM installed
  • Nx Workspace: Version 19.0.0 or higher

βš™οΈ Installation​

Follow these steps to set up your local environment:

  1. Clone the Repository

    Start by cloning the repository to your local machine:

    git clone git@github.com:otwld/velero-ui.git
  2. Install Nx

    Install Nx globally using one of the following commands:

    npm add --global nx@latest

    or

    npm install -g nx@latest
  3. Install dependencies with npm

    Install project dependencies by running:

    npm install
  4. Edit the .env.development, you can find references HERE

πŸš€ Serve​

  • Serve the API
nx serve velero-ui-api
  • Serve the APP
nx serve velero-ui

πŸ—οΈ Build​

  • Build the API
nx build velero-ui-api
  • Build the APP
nx build velero-ui