Axleshift Core 1

Pre-requisites

• Node.js v23.^
• Mongodb v8^
• Redis v7.^
• Docker
• Terraform
• Grafana
• PM2
• smee

---

1. Setup and Initialization

• Install Dependencies

  npm run setup

• Setup Environments

  npm run setup:env

---

2. Application Development

• Start Application

  npm run start

• Lint Code

  npm run lint

• Run Tests

  npm run test

• Run Tests in Production Mode

  npm run post:production

---

3. Docker Commands

• Build Docker Image

  npm run docker

• Run Docker Container

  npm run docker:run

---

4. Terraform Commands

• Run Terraform

  npm run terraform

---

5. Monitoring & Observability

• Start Prometheus Monitoring

  npm run prom

• Restart Prometheus

  npm run prom:restart

• Start Grafana

  npm run graf

• Restart Grafana

  npm run graf:restart

---

6. Process Management

• Start PM2 (Process Manager)

  npm run pm2

• Restart PM2

  npm run pm2:restart

---

License

This project is licensed under the MIT License with Commons Clause.

• Commercial Use Restriction: You may not use the software for commercial purposes, as defined in the LICENSE file. Commercial use includes using the software as part of any service offered for a fee or any use that generates revenue either directly or indirectly.

See the full LICENSE file for more details.

Disclaimer

This repository was previously part of the "Freight Capstone" GitHub organization. It has since been migrated to the "Axleshift" GitHub organization. Any references to "Freight Capstone" in the codebase, documentation, or related materials should now be understood as referring to "Axleshift."