Initial commit

CODE_OF_CONDUCT.md

@@ -0,0 +1,131 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+ * Demonstrating empathy and kindness toward other people
+ * Being respectful of differing opinions, viewpoints, and experiences
+ * Giving and gracefully accepting constructive feedback
+ * Accepting responsibility and apologizing to those affected by our mistakes,
+   and learning from the experience
+ * Focusing on what is best not just for us as individuals, but for the
+   overall community
+
+Examples of unacceptable behavior include:
+
+ * The use of sexualized language or imagery, and sexual attention or
+   advances of any kind
+ * Trolling, insulting or derogatory comments, and personal or political attacks
+ * Public or private harassment
+ * Publishing others' private information, such as a physical or email
+   address, without their explicit permission
+ * Other conduct which could reasonably be considered inappropriate in a
+   professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the project lead at `WillBAnders@gmail.com`. All complaints will be
+reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available
+at [https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

CONTRIBUTING.md

@@ -0,0 +1,16 @@
+# Contributing
+
+Thank you for your interest in contributing! Please note that while this is a
+public repository, this project is primarily a learning experience and thus
+outside contributions to development are not currently accepted*. However, you
+are welcome to contribute in other ways such as:
+
+ - Reporting bugs, issues, or other unintentional behavior discovered on
+   [https://ufssd.org](https://ufssd.org), especially for browser compatibility.
+ - Suggesting features/improvements to our website, which should first go
+   through current SSD officers prior to any development discussion.
+
+> *Following the conclusion of the project, this repository will be opened up to
+> development contributions for ongoing maintenance and improvements.
+
+If you have any questions, feel free to ask in our [Discord Server](https://discord.gg/5SyB3yx).

LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) UFSSD & Contributors
+
+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:
+
+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.

README.md

@@ -0,0 +1,44 @@
+# ufssd-website
+
+A `React`/`Next.js` project for [https://ufssd.org](https://ufssd.org) using
+Static Site Generation (SSG).
+
+## Overview
+
+This project aims to help students learn software engineering and web
+development through rebuilding the [UFSSD](https://ufssd.org) website. Team
+members will work through four 2-week sprints where they will use Agile
+processes, ticket issues, create and review PRs, and utilize other industry
+practices for software development.
+
+### Tech Stack
+
+The core framework is `React`/`Next.js` and Static Site Generation (SSG).
+Additional technologies used are `CSS Modules`/`Tailwind CSS` (styling),
+`ESLint`/`Prettier` (linting), and `GitHub Pages` (deployment). As the project
+progresses this may expand to fulfill other needs like testing and CI/CD.
+
+## Quickstart
+
+<details>
+  <summary>Prerequisites:</summary>
+
+ 1. Install [Git](https://git-scm.com/download) and configure for [GitHub](https://docs.github.com/en/get-started/quickstart/set-up-git).
+ 2. Install a [recent (16.14+)](https://nextjs.org/docs/getting-started/installation) version of [Node.js](https://nodejs.org/en/download) (latest v20 recommended).
+     - Alternatively, use [nvm](https://github.com/nvm-sh/nvm)/[nvm-windows](https://github.com/coreybutler/nvm-windows) if you need to support multiple Node versions.
+ 3. (Recommended) Install an IDE of your choice (e.g. [Webstorm](https://www.jetbrains.com/webstorm/)/[VSCode](https://code.visualstudio.com/)).
+ 4. (Recommended) Install React Developer Tools for the browser of your choice (e.g. [Chrome](https://chrome.google.com/webstore/detail/react-developer-tools/fmkadmapgofadopljbjfkapdkoienihi)).
+</details>
+
+Project Installation:
+ 1. Use `git clone https://github.com/ufssd/ufssd-webiste` to clone the project.
+ 2. Run `npm install` to install dependencies.
+ 3. Run `npm run dev` to start the development server.
+ 4. Visit `localhost:3000` to view the website.
+
+### Notable Commands
+
+ - `npm run dev`: Starts the development server at `localhost:3000`
+ - `npm run build`: Builds an exported static site to `/out`
+ - `npm run lint`: Runs eslint/prettier checking over `/src`
+    - `npm run lint:fix`: Fixes any auto-fixable lint errors