Skip to content

Latest commit

 

History

History
75 lines (47 loc) · 1.32 KB

CONTRIBUTING.md

File metadata and controls

75 lines (47 loc) · 1.32 KB
Raw

Contributing

Development

To make contributions to this project, make sure you have Nodejs 18 installed.

  1. Clone the repository:

    git clone git@github.com:canonical/sdcore-nms.git

  2. Navigate to the project directory:

    cd sdcore-nms

  3. Install the dependencies:

    npm install

  4. Run the development server:

    npm run dev

Open http://localhost:3000 with your browser to view the changes.

Testing

This project uses ESLint and Prettier for linting and code formatting.

💡 We recommend using the Prettier extension for VSCode for easy on-save code formatting.

To run lint check:

npm run lint

Build

To build the project:

npm run build

Container image

Pack the rock

sudo snap install rockcraft --edge --classic
rockcraft pack -v

Move the rock to Docker's registry

sudo rockcraft.skopeo --insecure-policy copy oci-archive:sdcore-nms_0.2.0_amd64.rock docker-daemon:sdcore-nms:0.2.0

Run the NMS

docker run -p 3000:3000 sdcore-nms:0.2.0

You will have the NMS available in http://localhost:3000.