Develop

.env.sample

@@ -7,12 +7,14 @@ VITE_IS_SAAS_BUILD=
 VITE_BASE_URL=
 
 # EE customisations/branding
-ENV VITE_PRODUCT_NAME=
-ENV VITE_TENANT_LOGO_DARK_URL=
-ENV VITE_TENANT_LOGO_LIGHT_URL=
-ENV VITE_TENANT_LOGO_DARK_SMALL_URL=
-ENV VITE_TENANT_LOGO_LIGHT_SMALL_URL=
-ENV VITE_TENANT_LOGO_ALT_TEXT=
+VITE_PRODUCT_NAME=
+VITE_TENANT_LOGO_DARK_URL=
+VITE_TENANT_LOGO_LIGHT_URL=
+VITE_TENANT_LOGO_DARK_SMALL_URL=
+VITE_TENANT_LOGO_LIGHT_SMALL_URL=
+VITE_TENANT_LOGO_ALT_TEXT=
+VITE_TENANT_FAVICON_LOGO=
+VITE_TENANT_PRIMARY_COLOR=
 
 # Other vars
 VITE_NETCLIENT_BIN_URL_TEMPLATE=

.goreleaser.yml

@@ -0,0 +1,4 @@
+builds:
+  - skip: true
+release:
+  prelease: false

CONTRIBUTING.md

@@ -0,0 +1,51 @@
+# Contributing to Netmaker UI
+We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
+
+- Reporting a bug
+- Discussing the current state of the code
+- Submitting a fix
+- Proposing new features
+
+## We Develop with Github
+We use github to host code, to track issues and feature requests, as well as accept pull requests.
+
+## We Use a [Github Flow variant](https://docs.github.com/en/get-started/quickstart/github-flow), So All Code Changes Happen Through Pull Requests
+Pull requests are the best way to propose changes to the codebase (we use [Github Flow](https://docs.github.com/en/get-started/quickstart/github-flow)). We actively welcome your pull requests:
+
+1. Fork the repo and create your branch from `develop`.
+2. If you've added code that should be tested, add tests.
+3. Ensure the PR workflows pass.
+4. Issue that pull request!
+
+## Any contributions you make will be under the SSPL License
+In short, when you submit code changes, your submissions are understood to be under the same [SSPL License](LICENSE.txt) that covers the project, and requires you to sign a consent. Feel free to contact the maintainers if that's a concern.
+
+## Report bugs using Github's [issues](https://github.com/gravitl/netmaker-ui-2/issues)
+We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/gravitl/netmaker-ui-2/issues/new); it's that easy!
+
+## Write bug reports with detail, background, steps to reporduce and if possible sample code
+[This is an example](http://stackoverflow.com/q/12488905/180626) of a bug report, and I think it's not a bad model. Here's [another example from Craig Hockenberry](http://www.openradar.me/11905408).
+
+**Great Bug Reports** tend to have:
+
+- A quick summary and/or background
+- Steps to reproduce
+  - Be specific!
+  - Give sample code if you can. [This stackoverflow question](http://stackoverflow.com/q/12488905/180626) includes sample code that *anyone* with a base R setup can run to reproduce what I was seeing
+- What you expected would happen
+- What actually happens
+- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
+
+People *love* thorough bug reports. I'm not even kidding.
+
+## Use a Consistent Coding Style
+I'm borrowing these from [Facebook's Guidelines](https://github.com/facebook/draft-js/blob/a9316a723f9e918afde44dea68b5f9f39b7d9b00/CONTRIBUTING.md)
+
+* 2 spaces for indentation rather than tabs
+* You can try running `npm run lint` for style unification
+
+## License
+By contributing, you agree that your contributions will be licensed under the [project's license](LICENSE.txt).
+
+## References
+This document was adapted from the open-source contribution guidelines for [Facebook's Draft](https://github.com/facebook/draft-js/blob/a9316a723f9e918afde44dea68b5f9f39b7d9b00/CONTRIBUTING.md) and [this gist](https://gist.github.com/briandk/3d2e8b3ec8daf5a27a62)

Dockerfile.standalone

@@ -38,6 +38,7 @@ ENV VITE_TENANT_LOGO_DARK_SMALL_URL=
 ENV VITE_TENANT_LOGO_LIGHT_SMALL_URL=
 ENV VITE_TENANT_LOGO_ALT_TEXT=
 ENV VITE_TENANT_FAVICON_LOGO=
+ENV VITE_TENANT_PRIMARY_COLOR=
 
 
 # Other vars

README.md

@@ -4,9 +4,36 @@
 
 ## v0.20.4
 
-#### For more information, visit the official documentation site: [docs.netmaker.org](https://docs.netmaker.io)  
+**For more information, visit the official documentation site: [docs.netmaker.io](https://docs.netmaker.io)**
 
 
-#### LICENSE
+## LICENSE
+
+Netmaker UI's source code and all artifacts in this repository are freely available. All versions are published under the Server Side Public License (SSPL), version 1, which can be found under in [LICENSE.txt](LICENSE.txt).
+
+## Contributing
+
+We welcome contributions to Netmaker UI. Please see our [contributing guidelines](CONTRIBUTING.md) for more information.
+
+### Development
+
+#### Prerequisites
+
+- [Node.js](https://nodejs.org/)
+
+#### Getting Started
+
+1. Clone the repository
+2. Install dependencies: `npm install`
+3. Run the development server: `npm run dev`
+4. Open [http://localhost:5173](http://localhost:5173) with your browser to see the result. The port might be different depending on your environment.
+
+#### Building
+
+1. Run the build script: `npm run build`
+2. The build artifacts will be stored in the `dist/` directory.
+
+#### Testing
+
+1. Run the test script: `npm run test`
 
-Netmaker UI's source code and all artifacts in this repository are freely available. All versions are published under the Server Side Public License (SSPL), version 1, which can be found under the "licensing" directory: [LICENSE.txt](licensing/LICENSE.txt).

package.json

@@ -37,19 +37,19 @@
     "react-router-dom": "^6.14.1",
     "react-window": "^1.8.9",
     "sigma": "^2.4.0",
-    "swr": "^2.1.5",
+    "swr": "^2.2.0",
     "zustand": "^4.3.9"
   },
   "devDependencies": {
     "@testing-library/jest-dom": "^5.16.5",
     "@testing-library/react": "^14.0.0",
-    "@types/react": "^18.2.14",
-    "@types/react-dom": "^18.2.6",
+    "@types/react": "^18.2.15",
+    "@types/react-dom": "^18.2.7",
     "@types/react-window": "^1.8.5",
     "@typescript-eslint/eslint-plugin": "^5.61.0",
-    "@typescript-eslint/parser": "^5.61.0",
+    "@typescript-eslint/parser": "^5.62.0",
     "@vitejs/plugin-react": "^4.0.1",
-    "eslint": "^8.44.0",
+    "eslint": "^8.45.0",
     "eslint-config-prettier": "^8.8.0",
     "eslint-plugin-prettier": "^4.2.1",
     "eslint-plugin-react": "^7.32.2",