The web-based API that supports the DOCme platform. Built with Express.js to run in the Node.js runtine environment.
For development, you will only need Node.js and optionally nodemon (for hot-reload) installed in your environement.
Just go on official Node.js website and download the installer. If the installation was successful, you should be able to run the following command and get back a version.
$ node --version
-
$ npm install -g nodemon
Go to official nodemon website for more information if needed.
$ npm install
Copy the file .env.example to a new file named .env and then edit it with the environment specific settings. This new file will be ignored by Git (don't need to ever commit).
The variables you will need are:
- Environment ('development' or 'production')
- Database host
- Database username
- Database password
- Better Doctor API user key
$ npm start
OR (for hot-reloading)
$ nodemon
$ npm build