Build a Full-Stack Vue Application

Create a simple todo app with Remult using a Vue frontend

In this tutorial, we are going to create a simple app to manage a task list. We'll use Vue for the UI, Node.js + Express.js for the API server, and Remult as our full-stack CRUD framework. For deployment to production, we'll use railway.app and a PostgreSQL database.

By the end of the tutorial, you should have a basic understanding of Remult and how to use it to accelerate and simplify full stack app development.

Prefer React?

Check out the React tutorial.

Prerequisites

This tutorial assumes you are familiar with TypeScript and Vue.

Before you begin, make sure you have Node.js and git installed.

Setup for the Tutorial

This tutorial requires setting up a Vue project, an API server project, and a few lines of code to add Remult.

You can either use a starter project to speed things up, or go through the step-by-step setup.

Option 1: Clone the Starter Project

1. Clone the vue-express-starter repository from GitHub and install its dependencies.

git clone https://github.com/remult/vue-express-starter.git remult-vue-todo
cd remult-vue-todo
npm install

2. Open your IDE.
3. Open a terminal and run the dev npm script.

npm run dev

4. Open another terminal and run the dev-node npm script

npm run dev-node

The default "Vue" app main screen should be available at the default Vite dev server address http://127.0.0.1:5173.

At this point, our starter project is up and running. We are now ready to move to the next step of the tutorial and start creating the task list app.

Option 2: Step-by-step Setup

Create a Vue project

Create the new Vue project.

npm init -y vue@latest

The command command prompts you for information about features to include in the initial app project. Here are the answers used in this tutorial:

1. Project name: ... remult-vue-todo
2. Add Typescript? ... Yes
3. For the rest of the answers, simply select the default.

Run into issues scaffolding the Vite project?

See Vite documentation for help.

Once completed, run:

cd remult-vue-todo

In this tutorial, we'll be using the root folder created by Vue as the root folder for our server project as well.

Install required packages

We need Express to serve our app's API, and, of course, Remult. For development, we'll use tsx to run the API server.

npm i express remult
npm i --save-dev @types/express tsx

Create the API server project

The starter API server TypeScript project contains a single module that initializes Express, and begins listening for API requests.

1. Open your IDE.

2. Create a server folder under the src/ folder created by Vite.

3. Create an index.ts file in the src/server/ folder with the following code:

// src/server/index.ts

import express from 'express'

const app = express()

app.listen(3002, () => console.log('Server started'))

Bootstrap Remult in the back-end

Remult is loaded in the back-end as an Express middleware.

1. Create an api.ts file in the src/server/ folder with the following code:

// src/server/api.ts

import { remultExpress } from 'remult/remult-express'

export const api = remultExpress()

2. Add the highlighted code lines to register the middleware in the main server module index.ts.

// src/server/index.ts

import express from "express"
import { api } from "./api.js"

const app = express()
app.use(api)

app.listen(3002, () => console.log("Server started"))

ESM

In this tutorial we will be using esm for the node.js server - that means that where ever we import a file we have to include the .js suffix for it as we did above in the import { api } from "./api.js statement

Final tweaks

Our full stack starter project is almost ready. Let's complete these final configurations.

Enable TypeScript decorators in Vite

Add the following entry to the defineConfig section of the vite.config.ts file to enable the use of decorators in the Vue app.

// vite.config.ts

// ...
export default defineConfig({
  plugins: [vue()],
  esbuild: {
    tsconfigRaw: {
      compilerOptions: {
        experimentalDecorators: true,
      },
    },
  },
});

Create the server tsconfig file

In the root folder, create a TypeScript configuration file tsconfig.server.json for the server project.

{
  "compilerOptions": {
    "experimentalDecorators": true,
    "skipLibCheck": true,
    "esModuleInterop": true,
    "outDir": "dist",
    "rootDir": "src",
    "module": "nodenext"
  },
  "include": ["src/server/**/*", "src/shared/**/*"]
}

Proxy API requests from Vue DevServer (vite) to the API server

The Vue app created in this tutorial is intended to be served from the same domain as its API. However, for development, the API server will be listening on http://localhost:3002, while the Vue app is served from the default http://localhost:5173.

We'll use the proxy feature of Vite to divert all calls for http://localhost:5173/api to our dev API server.

Configure the proxy by adding the following entry to the vite.config.ts file:

// vite.config.ts

//...
export default defineConfig({
  plugins: [vue()],
  server: { proxy: { "/api": "http://localhost:3002" } },
  esbuild: {
    tsconfigRaw: {
      compilerOptions: {
        experimentalDecorators: true,
      },
    },
  },
});

Run the app

1. Open a terminal and start the vite dev server.

npm run dev

2. Add an npm script named dev-node to start the dev API server in the package.json.

// package.json

"dev-node": "tsx watch --tsconfig tsconfig.server.json src/server"

3. Open another terminal and start the node server

npm run dev-node

The server is now running and listening on port 3002. tsx is watching for file changes and will restart the server when code changes are saved.

The default "Vue" app main screen should be available at the default Vite dev server address http://127.0.0.1:5173.

Remove Vue default styles

The vue default styles won't fit our todo app. If you'd like a nice-looking app, replace the contents of src/assets/main.css with this CSS file. Otherwise, you can simply delete the contents of src/assets/main.css.

Setup completed

At this point, our starter project is up and running. We are now ready to move to the next step of the tutorial and start creating the task list app.