Skip to content

Latest commit

 

History

History
82 lines (59 loc) · 4.47 KB

README.md

File metadata and controls

82 lines (59 loc) · 4.47 KB
Raw

Installation

  1. Clone the repository
  • Execute the npm install --production command to install the application's dependencies
  • Execute the npm install --development command to install the development dependencies
  • Rename .env.example to .env
  • Change the environment variables within the .env file
  • Run the npm run build command to build your application.

Serving front-end content

In order to serve front-end content, simply create a public directory within your application's source/build path and place the content within the newly created directory. Please note that any non-defined routes will by default redirect to this directory. You can change this default behavior from inside src/router.

Security

It is highly recommended that you secure any client accessing the end-points to help prevent man in the middle attacks, securing the connection is critical to the security of the application and it's end user.

If you wish to secure the connection via a proxy, then you may do so by enabling the APP_BEHIND_PROXY option within the .env file.

You may also secure the connection directly and this can optionally be used with a proxy server, this is enabled by the APP_SECURE option within the .env file. Setting this value to true will require you to include your key.pem and certificate.pem files within your root directory, or you can optionally let greenlock handle it.

If you're setting up a local development environment, you can create your own self-signed certificates by creating them with the command below, and then installing the certificate.pem to your list of locally trusted roots.

openssl req -x509 -out certificate.pem -keyout key.pem \
  -newkey rsa:2048 -nodes -sha256 \
  -subj '/CN=localhost' -extensions EXT -config <( \
   printf "[dn]\nCN=localhost\n[req]\ndistinguished_name = dn\n[EXT]\nsubjectAltName=DNS:localhost\nkeyUsage=digitalSignature\nextendedKeyUsage=serverAuth")

Setup

The application uses a monogodb database.

Starting the application

  • Run the npm run start command in order to start the server. The start script should use forever to help ensure that your content is continuously being served.
  • Run the npm run start:dev command in order to start the server in development mode. The develop script uses nodemon to restart based on changes made within the src directory (This command should not be used in a production environment).

Available Scripts

  • start - starts the server,
  • start:dev - starts a server directly from the source that reloads on changes,
  • clean - remove coverage data, Jest cache and transpiled files,
  • prebuild - lint source files and tests before building,
  • build - transpile TypeScript to ES6,
  • build:watch - interactive watch mode to automatically transpile source files,
  • lint - lint source files and tests,
  • test - run tests,
  • test:watch - interactive watch mode to automatically re-run tests,
  • mogront - creates and manages database migrations and seeders. (Docs)

Debugging

The application will throw debug errors if something abnormal occurs. You may view these errors by enabling the debug options in your cli using the following command DEBUG=app:*, if you're using a windows operating system then you can enable the debug options with this command instead set debug=app:* and then running the npm run dev command afterwards. The app part should be changed to whatever your APP_NAME is set to within your .env file, for example if your APP_NAME is my-test-app, then your debug command would look something like DEBUG=my-test-app:* if you're running linux, or set debug=my-test-app:* if you're running windows.

Contributing/Developing

UwU

Testing

The application utilizes Mocha and Chai and Chai-HTTP to conduct it's unit tests.

  • Follow the installation steps above
  • Change the value of the NODE_ENV variable within the .env file to testing
  • Rebuild the application

Run the npm run test command in order to start executing the test cases.