# siimee backend API

An API for the siimee application

## :white_check_mark: Prerequisites

You will need...

### Node.js 14+

-   OSX: `brew install node` using [Homebrew](http://brew.sh/)
-   Linux: `apt install nodejs` ([see Ubuntu/Debian specific instructions](https://nodejs.org/en/download/package-manager/#debian-and-ubuntu-based-linux-distributions)) or `pacman -S nodejs` (Arch Linux)
-   Windows: [Install](https://nodejs.org/en/download/)

## :package: Installation

1. Install dependencies with `npm install`

## :electric_plug: Run

1. Run `npm run dev` to start up the server

## :robot: Deployment

TBD

## :pill: Tests & Code Quality

TBD

## :heart: Built With

-   [Vue.js](https://vuejs.org/) - Our framework
-   [Vite](https://vitejs.dev/) - Next generation build tooling