Skip to main content

Getting Started

Let's get started developing your first new feature as a Voxable developer in less than 5 minutes.

Prerequisites​

  • Node.js (v18.8.0 or higher)
  • asdf is a great way to manage your Node.js and npm versions
  • Docker (v20.10.8 or higher)
  • Docker Compose (v1.29.2 or higher)
  • Git (v2.33.0 or higher)

Setup​

  1. Clone the repository

    git clone

  2. Install dependencies (yes, you need --force, for the moment)

    npm install --force

  3. Start the development environment

    npx nx serve

  4. Run NX console

    1. Navigate to the NX Sidebar
    2. Select run-many from the list of common NX commands.
    3. Select serve
    4. Select and run nx run-many --target=serve

  5. Open the app in your browser

    open http://localhost:3000

Next Steps​

  • Learn about the project structure
  • Learn about the development environment
  • Learn about the database
  • Learn about the API
  • Learn about the frontend
  • Learn about the deployment process

Resources​