Merge pull request #105 from phillipsharring/start-2024

Start 2024

.eslintrc.json

@@ -0,0 +1,7 @@
+{
+  "extends": "airbnb-base",
+  "parser": "@babel/eslint-parser",
+  "env": {
+    "browser": true
+  }
+}

.prettierrc

@@ -0,0 +1,8 @@
+{
+  "tabWidth": 2,
+  "useTabs": false,
+  "singleQuote": true,
+  "printWidth": 120,
+  "trailingComma": "all",
+  "plugins": ["prettier-plugin-tailwindcss"]
+}

.vscode/extensions.json

@@ -0,0 +1,3 @@
+{
+  "recommendations": ["bradlc.vscode-tailwindcss", "ritwickdey.LiveServer", "ExodiusStudios.comment-anchors"]
+}

.vscode/settings.json

@@ -1,21 +1,23 @@
 {
-    "cSpell.words": [
-        "Arepa",
-        "Beale",
-        "bsides",
-        "bsidesrdu",
-        "Buttar",
-        "eversec",
-        "gabemarshall",
-        "Kaminsky",
-        "Kimmon",
-        "Lockpick",
-        "lockpicking",
-        "Locksport",
-        "Shahid",
-        "Stoll",
-        "Vixie",
-        "Wysopal",
-        "Zilla"
-    ]
+  "cSpell.words": [
+    "Arepa",
+    "Beale",
+    "bsides",
+    "bsidesrdu",
+    "Buttar",
+    "eversec",
+    "gabemarshall",
+    "Kaminsky",
+    "Kimmon",
+    "Lockpick",
+    "lockpicking",
+    "Locksport",
+    "Shahid",
+    "Stoll",
+    "tailwindcss",
+    "Vixie",
+    "Wysopal",
+    "Zilla"
+  ]
+  "liveServer.settings.root": "./docs"
 }

LICENSE

@@ -1,21 +1,7 @@
-MIT License
+ISC License
 
 Copyright (c) 2023 BSidesRDU
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

README.md

@@ -11,3 +11,56 @@ Security is top of mind across the entire sphere of IT and the world beyond. The
 
 With many tech-companies, colleges and universities in Raleigh, Durham, Chapel Hill and surrounding areas, it is also an international center of innovation in the security industry.
 
+## Development
+
+Work in a branch. In fact, fork the main repo on GitHub, and work in a branch on your fork.
+
+```shell
+git checkout -b my-new-branch
+```
+
+Edit the `docs/index.html` file directly. It's not necessary to edit `src/input.css` if you don't use anything but tailwindcss utility classes.
+
+### Dev Server
+
+To start the "dev server", do:
+
+```shell
+npm start
+```
+
+This starts the `server:dev` and `watch:tailwind` scripts defined in `package.json`.
+
+The `server:dev` script starts `live-server` on the `docs` directory. Live-server will pick an open port on your machine, and launch a web browser on `localhost:{PORT}`. Keep this page open in one window, and your editor open in another window. The page will automatically reload when you save.
+
+The `watch:tailwind` script in turn runs the `tailwind --watch` command. CSS will be compiled with tailwindcss defaults and any utility classes used in the html files. This uses the `src/input.css` file. Don't remove this file. It's not necessary to edit this file if you only use tailwindcss utility classes.
+
+Tailwindcss is watching all HTML in the `docs` directory. When tailwindcss detects a change in one of those files, it builds the `docs/css/style.css` file. In turn, live-server will detect the change and reload the web page. Live-server is set to simply reload the css, not to "inject" it. This works best.
+
+### The `docs` Directory
+
+All "static" assets are in the `docs` directory. Leave them there. It's not necessary to move them or have a "build" process that compiles them. They're fine where they are.
+
+Please do not change the `docs` directory to `public` or `html` or `static`. The `docs` directory is where github looks for the web root. When a pull request is done into the `main` branch, a GitHub Action is kicked off that builds from that branch and deploys the website.
+
+
+
+### Suggested Global Packages
+
+It is recommended that you have the `live-server` package installed globally. Live-server is required to run the `server:dev` script. It's not necessary, per se, but it's nice to have. However, due to its global utility, it's not installed directly in this project.
+
+To install, do;
+
+```shell
+npm i -g live-server
+```
+
+## Deployment
+
+Once you're happy with your changes, push them up to github.
+
+```shell
+git push -u origin my-new-branch
+```
+
+Then, on [GitHub](https://github.com/BSidesRDU/website), open a pull request (PR) against the main branch. When your PR is approved and merged, the GitHub Action will kick off that deploys the site. It's nice if someone previews your changes and code before it's merged.