Aliases

Useful aliases for faster development setup.

Previously, we recommended setting up aliases directly for your shell (e.g. in $PROFILE or ~/.bashrc for Windows or Unix). However, we have now moved all aliases/scripts into the NPM package.json file.

"scripts": {
    "packages:build": "npm run build --workspaces",
    "docker:build": "docker build -t edroplets_backend server/",
    "docker:buildmac": "docker build -t edroplets_backend server/ --platform linux/amd64",
    "docker:dev": "docker compose -f docker-compose.yml -f docker-compose.dev.yml up",
    "docker:stop": "docker compose -f docker-compose.yml -f docker-compose.dev.yml down",
    "docker:reset": "cross-env RESET_DATABASE=Yes docker compose -f docker-compose.yml -f docker-compose.dev.yml up",
    "docker:migrate": "cross-env MIGRATE_DATABASE=Yes docker compose -f docker-compose.yml -f docker-compose.dev.yml up",
    "docker:flush": "cross-env RESET_DATABASE=Yes MIGRATE_DATABASE=Yes docker compose -f docker-compose.yml -f docker-compose.dev.yml up",
    "docker:restart": "docker compose -f docker-compose.yml -f docker-compose.dev.yml restart edroplets_backend",
    "docker:sql": "docker exec -it edroplets_db mysql -u edroplets -p edroplets",
    "docker:sqlroot": "docker exec -it edroplets_db mysql -u root -p edroplets",
    "client:dev": "npm run dev --prefix client",
    "client:build": "npm run build --prefix client",
    "community:dev": "npm run dev --prefix community",
    "community:build": "npm run build --prefix community",
    "dev:all": "concurrently -n server,client,community \"npm run docker:dev\" \"npm run client:dev\" \"npm run community:dev\"",
    "dev:client": "concurrently -n server,client \"npm run docker:dev\" \"npm run client:dev\"",
    "dev:community": "concurrently -n server,community \"npm run docker:dev\" \"npm run community:dev\"",
    "prepare": "husky"
},
  • packages:build: builds all packages

  • docker:build: builds the backend Docker image with the Dockerfile in the server directory

  • docker:buildmac: same as docker:build but builds for x86-64 architecture when host computer is ARM (e.g. on the new Macs)

    • If you have errors with the normal build script, try this one

Last updated