diff --git a/.nvmrc b/.nvmrc new file mode 100644 index 0000000..c1cedab --- /dev/null +++ b/.nvmrc @@ -0,0 +1 @@ +v20.1.0 diff --git a/README.md b/README.md index c8e5b6c..c3185c6 100644 --- a/README.md +++ b/README.md @@ -6,38 +6,41 @@ Visual Subnet Calculator is a modernized tool based on the original work by [dav It strives to be a tool for quickly designing networks and collaborating on that design with others. It focuses on expediting the work of network administrators, not academic subnetting math. -## Design Tenants +## Design Tenets -The following tenants are the most important values that drive the design of the tool. New features, pull requests, etc -should align to these tenants, or propose an adjustment to the tenants. +The following tenets are the most important values that drive the design of the tool. New features, pull requests, etc +should align to these tenets, or propose an adjustment to the tenets. - **Simplicity is king.** Network admins are busy and Visual Subnet Calculator should always be easy for FIRST TIME USERS to quickly and intuitively use. - **Subnetting is design work.** Promote features that enhance visual clarity and easy mental processing of even the most complex architectures. - **Users control the data.** We store nothing, but provide convenient ways for users to save and share their designs. -- **Embrace community contributions.** Consider and respond to all feedback and pull requests in the context of these - tenants. +- **Embrace community contributions.** Consider and respond to all feedback and pull requests in the context of these + tenets. ## Building From Source If you have a more opinionated best-practice way to lay out this repository please open an issue. Build prerequisites: -- npm -- sass +- (Optional but recommended) NVM to manage node version +- node.js (version 20) and associated NPM. +- sass (Globally installed, following instructions below.) Compile from source: ```shell # Clone the repository > git clone https://github.com/ckabalan/visualsubnetcalc +# Use reccomended NVM version +> nvm use # Change to the sources directory > cd visualsubnetcalc/src # Install Bootstrap > npm install -# Compile Bootstrap -> sass --style compressed scss/custom.scss:../dist/bootstrap.min.css +# Compile Bootstrap (Also install sass command line globally) +> npm run build ``` The full application should then be available within `./dist/`, open `./dist/index.html` in a browser. diff --git a/dist/index.html b/dist/index.html index adf9720..b96c621 100644 --- a/dist/index.html +++ b/dist/index.html @@ -163,12 +163,12 @@