HomePT is an Exercise Prescription Website. Here providers can prescribe tailored exercises for their clients, using videos and instructional guides.
This README covers installation and basic usage of the site. For further information, please refer to our Wiki.
Create a local folder with this repo with cmd ($ signifies terminal cmd):
$ git clone git@github.com:AFresnedo/backend-pt.git
This back end requires NodeJS to run. After installation, you may install prerquisite modules.
To install prerequisites, navigate to the top folder in the repo and type:
$ npm install
This app uses MongoDB for the database. Refer to MongoDB's installation instructions, if you do not have it already installed.
You will need to create a .env file, at the top level, with the following:
JWT_SECRET='set_your_secret_key_here_developer'
MONGODB_URI='your_mongodb_database_path_for_this_app_here_developer'
PORT=set_your_preferred_port_number_here_developer
JWT_SECRET should be a strong and unique key of your choosing.
Please give the address of the database you wish to use by entering it as the value for MONGODB_URI. It does not need to already exist.
If you skip adding the "PORT" line it will use a default of 3000.
We recommend using nodemon to run the server. Refer to nodemon's instructions, if you are going to use it.
If you do not wish to use nodemon, you can fire up the server using:
$ node index.js
Tests are run using Mocha and are written using Chai with the expect BDD style.
To run all the tests,
$ npm test
Please refer to Mocha's documentation for selecting individual test suites.