From 5fee8d3b0a97d98b6def0d75c7a6ce6ab743d078 Mon Sep 17 00:00:00 2001 From: codeshaine Date: Thu, 19 Dec 2024 22:21:08 +0530 Subject: [PATCH] Feat: setted up the project for open source contributions --- CODE_OF_CONDUCT.md | 74 ++++++++++++++++++++++++++++++++++ CONTRIBUTING.md | 35 ++++++++++++++++ LICENSE | 21 ++++++++++ README.md | 54 ++++++++++++++++++++++++- src/App.tsx | 13 +++--- src/components/CommandArea.tsx | 10 ----- src/components/Terminal.tsx | 24 ----------- src/util/GetOutput.tsx | 3 +- 8 files changed, 190 insertions(+), 44 deletions(-) create mode 100644 CODE_OF_CONDUCT.md create mode 100644 CONTRIBUTING.md create mode 100644 LICENSE diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..54a0591 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,74 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to make participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, gender identity and expression, level of experience, +nationality, personal appearance, race, religion, or sexual identity and +orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +- Using welcoming and inclusive language +- Being respectful of differing viewpoints and experiences +- Gracefully accepting constructive criticism +- Focusing on what is best for the community +- Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +- The use of sexualized language or imagery and unwelcome sexual attention or + advances +- Trolling, insulting/derogatory comments, and personal or political attacks +- Public or private harassment +- Publishing others' private information, such as a physical or electronic + address, without explicit permission +- Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers 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, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. Examples of +representing a project or community includes using an official project e-mail +address, posting via an official social media account, or acting as an appointed +representative at an online or offline event. Representation of a project may be +further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting opensource@github.com, which is a shared team inbox. If the incident involves someone who receives that shared inbox, you can contact an individual maintainer (@bkeepers or @nayafia) at `GitHub username` + `@github.com`. All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality with regard to the reporter of an incident. +Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +available at [https://contributor-covenant.org/version/1/4][version] + +[homepage]: https://contributor-covenant.org +[version]: https://contributor-covenant.org/version/1/4/ diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..cfc09fc --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,35 @@ +# Contributing to the Portfolio Project + +Thank you for considering contributing to the terminal-themed portfolio site! + +## How You Can Contribute + +1. **Create an Issue** + If you find a bug or have a feature request, please create an issue in the repository. Describe the problem or feature clearly. + +2. **Fork the Repo** + If you'd like to contribute, please fork the repository and clone it locally. + +3. **Create a Feature Branch** + Create a new branch for your feature or fix: + + ```bash + git checkout -b username/feature + ``` + +4. **Install Dependencies** + Make sure you have [pnpm](https://pnpm.io/) installed. Install the project dependencies by running: + + ```bash + pnpm install + ``` + +5. **Make Your Changes** + Implement the changes, ensuring your code follows the project's style and structure. Be sure to write meaningful commit messages. + +6. **Create a Pull Request** + Once your feature or bug fix is complete, push your changes and open a pull request (PR). Describe the changes made and reference any related issues. + +## License + +By contributing, you agree that your contributions will be licensed under the **MIT License**. diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..69860d0 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2024 codeshaine + +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. diff --git a/README.md b/README.md index 7235031..96ef178 100644 --- a/README.md +++ b/README.md @@ -1 +1,53 @@ -# Portfolio site +# Terminal Themed Portfolio + +Welcome to my **Terminal Themed Portfolio**! This is a personal portfolio project with a unique terminal interface. It allows users to interact with a terminal-like environment to explore my work, skills, and projects. + +## Features + +- **Interactive Terminal UI**: Navigate and interact with the portfolio using terminal commands. +- **Project Showcase**: View details about various projects through a simulated terminal interface. +- **Responsive Design**: Optimized for both desktop and mobile devices. +- **Easy Navigation**: Commands to explore different sections of the portfolio, such as skills, projects, and contact info. + +## Tech Stack + +- **Frontend**: + - TypeScript + - React (Vite) +- **Package Manager**: pnpm + +## Installation + +To get started with this project locally, follow these steps: + +1. **Clone the repository**: + + ```bash + git clone https://github.com/codeshaine/portfolio.git + cd portfolio + ``` + +2. **Install dependencies**: + Make sure you have [pnpm](https://pnpm.io/) installed. Then run: + + ```bash + pnpm install + ``` + +3. **Run the project**: + To start the development server, run: + + ```bash + pnpm dev + ``` + +4. **Open your browser**: + Navigate to `http://localhost:3000` to see your terminal-themed portfolio in action. + +## Contributing + +We welcome contributions! If you'd like to contribute, follow the steps in the [CONTRIBUTING.md](CONTRIBUTING.md). + +## License + +This project is licensed under the [MIT License](LICENSE). diff --git a/src/App.tsx b/src/App.tsx index 14f1e89..c1db4cc 100644 --- a/src/App.tsx +++ b/src/App.tsx @@ -1,11 +1,10 @@ import Terminal from "./components/Terminal"; export default function App() { - return <> - -
- @codeshaine - 2024 -
- - + return ( + <> + +
@codeshaine - 2024
+ + ); } diff --git a/src/components/CommandArea.tsx b/src/components/CommandArea.tsx index 29c45af..65c348f 100644 --- a/src/components/CommandArea.tsx +++ b/src/components/CommandArea.tsx @@ -27,16 +27,6 @@ export default function CommandArea() { window.removeEventListener("keydown", handleKeyDown); }; }, [commandList]); - // useEffect(() => { - // const handleKeyDown = () => { - // inputRef.current?.focus(); - // }; - - // window.addEventListener("keydown", handleKeyDown); - // return () => { - // window.removeEventListener("keydown", handleKeyDown); - // }; - // }, []); return (
diff --git a/src/components/Terminal.tsx b/src/components/Terminal.tsx index da046ac..808c738 100644 --- a/src/components/Terminal.tsx +++ b/src/components/Terminal.tsx @@ -37,30 +37,6 @@ export default function Terminal() {
- - {/*
- - - -
*/} ); } diff --git a/src/util/GetOutput.tsx b/src/util/GetOutput.tsx index b4e2464..16f7e80 100644 --- a/src/util/GetOutput.tsx +++ b/src/util/GetOutput.tsx @@ -92,8 +92,7 @@ export function GetOutput(

- Last updated on{" "} - 2-12-2024 + Last updated on 2-12-2024

);