Signal Annotation Tool (Server)

• Signal Annotation Tool
• Signal Annotation Tool (Client)
• Signal Annotation Tool (Server) (this repository)

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

The project requires the following software present on your local machine:

• MongoDB
  • a local instance listening on localhost:27017
• Node.js
• NPM

Installing

Once the prerequisites fulfilled, open a terminal, go to the root of this repository and run:

This step installs all dependencies:

npm install

For the development server to be running in incremental mode (i.e., changes in code will be catched and reflected automatically) simply run:

npm run watch

And then:

npm run start

At this point the server is running and you need to install the client.

Built With

• NestJS - The web framework used
• Socket.io - Real-time, bidirectional and event-based communication
• MongoDB - A popular NoSQL document-oriented database

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

License

This project is licensed under the MIT License - see the LICENSE.md file for details