/core

Core server for Cloud CNC

Primary LanguageJavaScriptMIT LicenseMIT

Core

status tests tests issues last commit FOSSA Status

Production

View guides, documentation and more at cloud-cnc.github.io

Development

Note: This repository contains all files for running a core server instance. The core server is typically ran on a VPS.

Environment Setup

  1. Setup a Mongo database
  2. Install Node Gyp (Using these instructions)
  3. Install dependencies via running npm i
  4. Generate an X509 certificate (certificate.cer) and key (key.pem) in the config directory
  5. Run npm start to start the API server in production

NPM Scripts

Name Description
coverage Run all unit tests and generate coverage reports
start Run the server in production mode
start:development Run the server in development mode
start:docker Run server in production mode - logs to console instead of files (Docker containers don't actually use this command but it uses the exact same environment variables as the Docker containers)
test Run unit + integration tests (E2E tests are ran from the frontend repository)

License

FOSSA Status