Setting up a Local Development Environment

These are instructions for getting started on a Mac/unix machine. Windows instructions TBD.

Dependencies

Install these dependencies if you don't already have them:

git
nvm

Download

Clone the source code with the HTTP:

git clone https://github.com/APL-Innovation-Lab/meeting-room-prototype

or with SSH:

git clone [email protected]:APL-Innovation-Lab/meeting-room-prototype

Configuration

install (if necessary) and use with nvm:

cd meeting-room-prototype
nvm install # if necessary
nvm use

Install NPM dependencies:

npm install

And run the dev server:

npm run dev

Visual Studio Code

It's recommended to use Visual Studio Code as your integrated development environment when working on this prototype for the best development experience. There are several files in this repo's .vscode root-level folder which are intended to enhance this experience with additional settings to make development smooth in VS Code.

Extensions

It's also recommended that you install these extensions for VS Code:

ESLint for inline linting errors and auto-fix-on-save support
Prettier for format-on-save support
npm Intellisense for autocomplete in package.json and quick npm script actions in the sidebar
Tailwind CSS Intellisense for:

Inline color swatches