emmanuelbeziat-state

🔔 Get some build logs out without needing to connect to my server.

GPL-3.0 License

Stars
0
Committers
2

Emmanuel Béziat Logo emmanuelbeziat-state :: Emmanuel Béziat

🔔 Get some build logs out without needing to connect to my server.

What?

  • Fetch build logs
  • Environment configuration using dotenv

Installation

# Get the repo
git clone git+ssh://[email protected]/EmmanuelBeziat/emmanuelbeziat-state.git

# Navigate into project folder
cd emmanuelbeziat-state

# Intall dependencies
npm i

.env file example:

PORT=3000
HOST="127.0.0.1"
LOGS_PATH="/var/logs/mywebsite"
FILE_LOG="mywebsite.log"
FILE_STATUS="status.log"
SERVICES_LIST=[{ "name": "<app_name>", "url": "<app_url>"}]
WEBSOCKET_PORT=<port>
AUTH_USERNAME=<your_username>
AUTH_PASSWORD=<your_password>

Usage

  • Start the application in development mode:

    npm run dev
    

    Launches the application with hot-reloading for development, with changes in real-time with node watch.

  • Start the application in production mode:

    npm run prod
    

    Runs the application in a production environment, optimized for performance and stability, with nodemon.

  • Deploy the application:

    npm run deploy
    

    Deploys the application for production using PM2.

  • Run tests:

    npm run test
    

    Run all tests

  • Run route tests:

    npm run test:routes
    

    Specifically tests the application's routes to verify that they respond correctly.

  • Run environment tests:

    npm run test:env
    

    Checks the environment configurations to ensure all necessary variables are set correctly.

  • Run class tests:

    npm run test:class:home
    

    Runs tests for the Home class.

    npm run test:class:log
    

    Runs tests for the Log class.

  • Run filter tests:

    npm run test:filters
    

    Runs tests for filters.

  • Run template tests:

    npm run test:templates
    

    Runs tests for templates.

License

This project is licensed under the GPL-3.0-or-later License.

Related Projects