Merge branch 'release/v0.7.1'
This commit is contained in:
commit
b96fb1c295
5 changed files with 20 additions and 11 deletions
1
.nvmrc
Normal file
1
.nvmrc
Normal file
|
@ -0,0 +1 @@
|
|||
v20.1.0
|
19
README.md
19
README.md
|
@ -6,10 +6,10 @@ 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.
|
||||
|
@ -17,27 +17,30 @@ should align to these tenants, or propose an adjustment to the tenants.
|
|||
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.
|
||||
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.
|
||||
|
|
4
dist/index.html
vendored
4
dist/index.html
vendored
|
@ -163,12 +163,12 @@
|
|||
<div class="modal-body">
|
||||
Visual Subnet Calculator 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.<br />
|
||||
<br/>
|
||||
<h4>Design Tenants</h4>
|
||||
<h4>Design Tenets</h4>
|
||||
<ul>
|
||||
<li><span style="font-weight:bold">Simplicity is king.</span> Network admins are busy and Visual Subnet Calculator should always be easy for FIRST TIME USERS to quickly and intuitively use.</li>
|
||||
<li><span style="font-weight:bold">Subnetting is design work.</span> Promote features that enhance visual clarity and easy mental processing of even the mostcomplex architectures.</li>
|
||||
<li><span style="font-weight:bold">Users control the data.</span> We store nothing, but provide convenient ways for users to save and share their designs.</li>
|
||||
<li><span style="font-weight:bold">Embrace community contributions.</span> Consider and respond to all feedback and pull requests in the context of these tenants.</li>
|
||||
<li><span style="font-weight:bold">Embrace community contributions.</span> Consider and respond to all feedback and pull requests in the context of these tenets.</li>
|
||||
</ul>
|
||||
<h4 class="mt-4">Credits</h4>
|
||||
Developed by <a href="https://www.caesarkabalan.com/" target="_blank">Caesar Kabalan</a> with help from <a href="https://github.com/ckabalan/visualsubnetcalc/graphs/contributors" target="_blank">GitHub Contributors</a>!<br/>
|
||||
|
|
1
src/package-lock.json
generated
1
src/package-lock.json
generated
|
@ -4,6 +4,7 @@
|
|||
"requires": true,
|
||||
"packages": {
|
||||
"": {
|
||||
"hasInstallScript": true,
|
||||
"dependencies": {
|
||||
"bootstrap": "^5.2.3"
|
||||
}
|
||||
|
|
|
@ -1,5 +1,9 @@
|
|||
{
|
||||
"dependencies": {
|
||||
"bootstrap": "^5.2.3"
|
||||
},
|
||||
"scripts": {
|
||||
"postinstall": "npm install -g sass",
|
||||
"build":"sass --style compressed scss/custom.scss:../dist/bootstrap.min.css"
|
||||
}
|
||||
}
|
||||
|
|
Loading…
Reference in a new issue