├── .eslintrc.json
├── .github
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── ISSUE_TEMPLATE
│ ├── bug-report.md
│ └── feature-request.md
├── PULL_REQUEST_TEMPLATE.md
└── splash.gif
├── .gitignore
├── .husky
└── pre-commit
├── .prettierignore
├── .prettierrc.js
├── LICENSE
├── README.md
├── gitcheats.config.js
├── jsconfig.json
├── next.config.js
├── package.json
├── public
└── favicon.ico
├── src
├── components
│ ├── Card
│ │ └── index.js
│ ├── Code
│ │ └── index.js
│ ├── CopyButton
│ │ └── index.js
│ ├── Footer
│ │ └── index.js
│ ├── Loader
│ │ └── index.js
│ ├── SEO
│ │ └── index.js
│ └── Search
│ │ └── index.js
└── pages
│ ├── _app.js
│ ├── api
│ └── language.js
│ └── index.js
├── static
└── language
│ └── en.json
├── styles
├── card.css
├── code.css
├── copybutton.css
├── footer.css
├── globals.css
├── home.css
└── search.css
├── vercel.json
└── yarn.lock
/.eslintrc.json:
--------------------------------------------------------------------------------
1 | {
2 | "extends": ["next/core-web-vitals", "plugin:json/recommended", "next", "prettier"],
3 | "env": {
4 | "browser": true,
5 | "es2021": true
6 | },
7 | "plugins": ["prettier"],
8 | "rules": {
9 | "@next/next/no-img-element": 0,
10 | "react/no-unescaped-entities": 0,
11 | "react/display-name": 0,
12 | "import/no-anonymous-default-export": 0,
13 | "react-hooks/exhaustive-deps": "warn",
14 | "react-hooks/rules-of-hooks": "error",
15 | "no-tabs": 0,
16 | "prettier/prettier": "error"
17 | }
18 | }
19 |
--------------------------------------------------------------------------------
/.github/CODE_OF_CONDUCT.md:
--------------------------------------------------------------------------------
1 | # Contributor Covenant Code of Conduct
2 |
3 | ## Our Pledge
4 |
5 | In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making 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.
6 |
7 | ## Our Standards
8 |
9 | Examples of behavior that contributes to creating a positive environment include:
10 |
11 | * Using welcoming and inclusive language
12 | * Being respectful of differing viewpoints and experiences
13 | * Gracefully accepting constructive criticism
14 | * Focusing on what is best for the community
15 | * Showing empathy towards other community members
16 |
17 | Examples of unacceptable behavior by participants include:
18 |
19 | * The use of sexualized language or imagery and unwelcome sexual attention or advances
20 | * Trolling, insulting/derogatory comments, and personal or political attacks
21 | * Public or private harassment
22 | * Publishing others' private information, such as a physical or electronic address, without explicit permission
23 | * Other conduct which could reasonably be considered inappropriate in a professional setting
24 |
25 | ## Our Responsibilities
26 |
27 | 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.
28 |
29 | 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.
30 |
31 | ## Scope
32 |
33 | 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 include 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.
34 |
35 | ## Enforcement
36 |
37 | Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at hello@cancellek.com. The project team will review and investigate all complaints, and will respond in a way that it deems 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.
38 |
39 | 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.
40 |
41 | ## Attribution
42 |
43 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
44 |
45 | [homepage]: http://contributor-covenant.org
46 | [version]: http://contributor-covenant.org/version/1/4/
47 |
--------------------------------------------------------------------------------
/.github/CONTRIBUTING.md:
--------------------------------------------------------------------------------
1 | # Contributing To Git Cheats
2 |
3 | :octocat: Thanks for taking the time to contribute!
4 |
5 | The following is a set of guidelines for contributing to this repository.
6 | #### Table Of Contents
7 | [Code of Conduct](#code-of-conduct)
8 |
9 | [How Can I Contribute?](#how-can-i-contribute)
10 | - [Contributing To Git Cheats](#contributing-to-interactive-git-cheatsheet)
11 | - [Table Of Contents](#table-of-contents)
12 | - [Code of Conduct](#code-of-conduct)
13 | - [How Can I Contribute?](#how-can-i-contribute)
14 | - [Reporting Bugs](#reporting-bugs)
15 | - [Suggesting Enhancements](#suggesting-enhancements)
16 | - [Pull Requests](#pull-requests)
17 | - [Commit Messages](#commit-messages)
18 |
19 | ## Code of Conduct
20 | This project and everyone participating in it is governed by the [Git Cheats Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code.
21 |
22 | ## How Can I Contribute?
23 | ### Reporting Bugs
24 | Before creating bug reports, please perform a [cursory search](https://github.com/excalith/git-cheats/issues) to see if the problem has already been reported. If it has **and the issue is still open**, add a comment to the existing issue instead of opening a new one. When you are creating a bug report, please include as many details as possible. Fill out [the required template](ISSUE_TEMPLATE.md), the information it asks for helps us resolve issues faster.
25 |
26 | > **Note:** If you find a **Closed** issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.
27 |
28 |
29 | ### Suggesting Enhancements
30 | Before suggesting an enhancement, please perform a [cursory search](https://github.com/excalith/git-cheats/issues) to see if the suggestion has already been submitted.
31 |
32 | * **User a clear descriptive title** for the suggestion
33 | * **Describe the current behavior** and **explain which behavior you expected to see instead** and why
34 | * **Do not request complicated commands** since this project is to help people get the basic commands
35 |
36 | Unsure where to begin contributing? You can start by looking through these `beginner` and `help-wanted` issues:
37 |
38 | * [Beginner issues](https://github.com/excalith/git-cheats/labels/beginner) - issues which should only require a few lines of code, and a test or two.
39 | * [Help wanted issues](https://github.com/excalith/git-cheats/labels/help%20wanted) - issues which should be a bit more involved than `beginner` issues.
40 |
41 |
42 | ### Pull Requests
43 | While creating a Pull Request, fill out the [the required template](PULL_REQUEST_TEMPLATE.md)
44 |
45 | * **Do not** change design into a complicated and / or overwhelming experience
46 | * **Do not** include issue numbers in the PR title if any
47 | * **Include** screenshots or animated GIFs in your pull request if a new feature
48 |
49 |
50 | ### Commit Messages
51 | * Use the present tense ("Add feature" not "Added feature")
52 | * Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
53 | * Limit the first line to 72 characters or less
54 | * Reference issues and pull requests liberally after the first line
55 |
--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE/bug-report.md:
--------------------------------------------------------------------------------
1 | ---
2 | name: Bug Report
3 | about: Create a report to help us improve
4 | title: "[BUG] "
5 | labels: ''
6 | assignees: excalith
7 |
8 | ---
9 |
10 | **Describe the bug**
11 | A clear and concise description of what the bug is.
12 |
13 | **To Reproduce**
14 | Steps to reproduce the behavior:
15 | 1. Go to '...'
16 | 2. Click on '....'
17 | 3. Scroll down to '....'
18 | 4. See error
19 |
20 | **Expected behavior**
21 | A clear and concise description of what you expected to happen.
22 |
23 | **Screenshots**
24 | If applicable, add screenshots to help explain your problem.
25 |
26 | **Desktop (please complete the following information):**
27 | - OS: [e.g. macOS 13.1]
28 | - Browser [e.g. Firefox v109.0.1 ]
29 |
30 | **Additional context**
31 | Add any other context about the problem here.
32 |
--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE/feature-request.md:
--------------------------------------------------------------------------------
1 | ---
2 | name: Feature Request
3 | about: Suggest an idea for this project
4 | title: "[FEATURE] "
5 | labels: enhancement
6 | assignees: excalith
7 |
8 | ---
9 |
10 | **Is your feature request related to a problem? Please describe.**
11 | A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12 |
13 | **Describe the solution you'd like**
14 | A clear and concise description of what you want to happen.
15 |
16 | **Describe alternatives you've considered**
17 | A clear and concise description of any alternative solutions or features you've considered.
18 |
19 | **Additional context**
20 | Add any other context or screenshots about the feature request here.
21 |
--------------------------------------------------------------------------------
/.github/PULL_REQUEST_TEMPLATE.md:
--------------------------------------------------------------------------------
1 |
2 | ### Description of the Change
3 |
4 |
5 | ### Possible Drawbacks
6 |
7 |
--------------------------------------------------------------------------------
/.github/splash.gif:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/excalith/git-cheats/1c303de5ad010da411516af579a86de7e6c8a263/.github/splash.gif
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | # See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
2 |
3 | # dependencies
4 | /node_modules
5 | /.pnp
6 | .pnp.js
7 |
8 | # testing
9 | /coverage
10 |
11 | # next.js
12 | /.next/
13 | /out/
14 |
15 | # production
16 | /build
17 |
18 | # misc
19 | .DS_Store
20 | *.pem
21 |
22 | # debug
23 | npm-debug.log*
24 | yarn-debug.log*
25 | yarn-error.log*
26 | .pnpm-debug.log*
27 |
28 | # local env files
29 | .env*.local
30 |
31 | # vercel
32 | .vercel
33 |
34 | # typescript
35 | *.tsbuildinfo
36 | next-env.d.ts
37 |
--------------------------------------------------------------------------------
/.husky/pre-commit:
--------------------------------------------------------------------------------
1 | #!/bin/sh
2 | . "$(dirname "$0")/_/husky.sh"
3 |
4 | npx --no-install lint-staged
5 |
--------------------------------------------------------------------------------
/.prettierignore:
--------------------------------------------------------------------------------
1 | node_modules
2 | **/.next/**
3 | **/_next/**
4 | **/dist/**
5 | packages/next/bundles/webpack/packages/*.runtime.js
6 | packages/next/bundles/webpack/packages/lazy-compilation-*.js
7 | packages/next/compiled/**
8 | packages/react-refresh-utils/**/*.js
9 | packages/react-refresh-utils/**/*.d.ts
10 | packages/react-dev-overlay/lib/**
11 | **/__tmp__/**
12 | lerna.json
13 | .github/actions/next-stats-action/.work
14 | .github/actions/issue-validator/index.mjs
15 | packages/next-swc/crates/**/*
16 | packages/next-swc/target/**/*
17 | packages/next-swc/native/**/*
18 | packages/next-codemod/transforms/__testfixtures__/**/*
19 | packages/next-codemod/transforms/__tests__/**/*
20 | packages/next-codemod/**/*.js
21 | packages/next-codemod/**/*.d.ts
22 | packages/next-env/**/*.d.ts
23 | test-timings.json
24 | test/**/out/**
25 | bench/nested-deps/pages/**/*
26 | bench/nested-deps/components/**/*
27 | pnpm-lock.yaml
28 | **/convex/_generated/**
29 | build
30 | .github
--------------------------------------------------------------------------------
/.prettierrc.js:
--------------------------------------------------------------------------------
1 | module.exports = {
2 | bracketSpacing: true,
3 | bracketSameLine: true,
4 | singleQuote: false,
5 | trailingComma: "none",
6 | semi: false,
7 | useTabs: true,
8 | tabWidth: 4
9 | }
10 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | MIT License
2 |
3 | Copyright (c) 2015-2022 Can Cellek
4 |
5 | Permission is hereby granted, free of charge, to any person obtaining a copy
6 | of this software and associated documentation files (the "Software"), to deal
7 | in the Software without restriction, including without limitation the rights
8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 |
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 |
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 |
2 |
Git Cheats • Interactive Git Cheatsheet
3 |
4 |
5 | > **Warning**
6 | > This project has been integrated into a larger project called [Dev Cheats](https://github.com/excalith/dev-cheats), which includes expanded features and resources. As a result, this project will be archived soon. To continue accessing these resources and more, please update your bookmarks by visiting the [Dev Cheats - Git](https://dev-cheats.vercel.app/git) page. Thank you for your support!
7 |
8 | ---
9 |
10 |
11 | Git Cheats is an intuitive and user-friendly interactive Git cheatsheet that provides a handy reference for developers to search and access commonly used Git commands quickly and efficiently.
12 |
13 |
14 |
15 |
17 |
18 | ## Features
19 |
20 | With Git Cheats you can;
21 |
22 | - Easily search for commands by name
23 | - Filter a group of commands by category
24 | - Copy usage examples to paste into your terminal
25 | - Click any command name to launch the original documentation
26 | - Show and hide commands depending on their complexity through the menu (`Basic`, `Normal`, `Advanced`)
27 |
28 | Also includes `strict` cookies to remember your preferences next time you launch the app. Nothing is stored on the server.
29 |
30 | ## Usage
31 |
32 | ### Online
33 |
34 | You can find and bookmark the online version from [git-cheats.vercel.app](https://git-cheats.vercel.app)
35 |
36 | ### Local
37 |
38 | 1. Clone this repository
39 | 2. Run `yarn` to install dependencies
40 | 3. Run `yarn dev` to start server
41 |
42 | ### Docker
43 |
44 | Planning to add this feature soon.
45 |
46 | ## Technology
47 |
48 | - [ReactJS](https://reactjs.org/)
49 | - [NextJS](https://nextjs.org/)
50 | - [SWR](https://swr.vercel.app/)
51 | - [Bootstrap](https://getbootstrap.com/)
52 | - [Eslint](https://eslint.org/)
53 | - [Prettier](https://prettier.io/)
54 | - [Husky](https://typicode.github.io/husky/)
55 | - Hosted on [Vercel](https://vercel.com/) ♥
56 |
57 | For more information, please check [package.json](package.json)
58 |
59 | ## How To Contribute
60 |
61 | Please feel free to contribute any way you can. Just keep in mind that you should pay attention to [CONTRIBUTE.md](.github/CONTRIBUTING.md) before contributing.
62 |
63 | ## License
64 |
65 | This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.
66 |
67 | ## Other Useful Projects
68 |
69 | - [Git Init](https://pel-daniel.github.io/git-init) - Great learning tool for learning how to use commands
70 | - [Git - The Simple Guide](https://rogerdudler.github.io/git-guide) - Simple guide for getting started with git
71 | - [Learn Git Branching](https://learngitbranching.js.org) - Learn how to use branches properly
72 |
--------------------------------------------------------------------------------
/gitcheats.config.js:
--------------------------------------------------------------------------------
1 | export const DEFAULT_LANGUAGE = "en"
2 | export const AVAILABLE_LANGUAGES = ["en"]
3 |
--------------------------------------------------------------------------------
/jsconfig.json:
--------------------------------------------------------------------------------
1 | {
2 | "compilerOptions": {
3 | "module": "ESNext",
4 | "moduleResolution": "Node",
5 | "target": "ES2020",
6 | "jsx": "react",
7 | "strictNullChecks": true,
8 | "strictFunctionTypes": true
9 | },
10 | "exclude": ["node_modules", "**/node_modules/*"]
11 | }
12 |
--------------------------------------------------------------------------------
/next.config.js:
--------------------------------------------------------------------------------
1 | const { patchWebpackConfig } = require("next-global-css")
2 |
3 | const nextConfig = {
4 | reactStrictMode: true,
5 | swcMinify: true,
6 | productionBrowserSourceMaps: true
7 | }
8 |
9 | module.exports = nextConfig
10 |
--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "git-cheats",
3 | "version": "2.0.0",
4 | "homepage": "https://git-cheats.vercel.app/",
5 | "description": "A companion for git commands",
6 | "repository": "https://github.com/excalith/git-cheats.git",
7 | "license": "MIT",
8 | "private": false,
9 | "scripts": {
10 | "prepare": "husky install",
11 | "dev": "next dev",
12 | "build": "next build",
13 | "start": "next start",
14 | "lint": "next lint",
15 | "format": "prettier . --write"
16 | },
17 | "dependencies": {
18 | "@fontsource/fira-code": "^4.5.13",
19 | "@fontsource/rubik": "^4.5.14",
20 | "bootstrap": "^5.2.3",
21 | "cookies-next": "^2.1.1",
22 | "next": "13.1.4",
23 | "next-global-css": "^1.3.1",
24 | "react": "18.2.0",
25 | "react-dom": "18.2.0",
26 | "react-icons": "^4.7.1",
27 | "react-spinners": "^0.13.8",
28 | "swr": "^1.3.0"
29 | },
30 | "devDependencies": {
31 | "eslint": "<8.32.0",
32 | "eslint-config-next": "13.1.4",
33 | "eslint-config-prettier": "^8.6.0",
34 | "eslint-plugin-json": "^3.1.0",
35 | "eslint-plugin-prettier": "^4.2.1",
36 | "husky": "^8.0.3",
37 | "lint-staged": "^13.1.0",
38 | "prettier": "^2.8.3"
39 | },
40 | "browserslist": {
41 | "production": [
42 | ">10%",
43 | "not dead",
44 | "not ie 11",
45 | "not op_mini all"
46 | ],
47 | "development": [
48 | "last 1 chrome version",
49 | "last 1 firefox version",
50 | "last 1 safari version"
51 | ]
52 | },
53 | "lint-staged": {
54 | "*.{js,jsx,ts,tsx}": [
55 | "prettier --write",
56 | "eslint --fix"
57 | ],
58 | "static/language/*.json": [
59 | "eslint"
60 | ]
61 | },
62 | "husky": {
63 | "hooks": {
64 | "pre-commit": "node ./"
65 | }
66 | }
67 | }
68 |
--------------------------------------------------------------------------------
/public/favicon.ico:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/excalith/git-cheats/1c303de5ad010da411516af579a86de7e6c8a263/public/favicon.ico
--------------------------------------------------------------------------------
/src/components/Card/index.js:
--------------------------------------------------------------------------------
1 | import React, { useState, useEffect } from "react"
2 | import Link from "next/link"
3 | import Code from "../Code"
4 | import "@fontsource/rubik"
5 | import { BsFillArrowUpRightSquareFill } from "react-icons/bs"
6 |
7 | const Card = ({ data, query, complexity }) => {
8 | const [isHidden, setHidden] = useState(false)
9 |
10 | let link = "https://git-scm.com/docs/git-" + data.name
11 | let category = data.category.toLowerCase()
12 |
13 | useEffect(() => {
14 | if (data.complexity > complexity) {
15 | setHidden(true)
16 | return
17 | }
18 |
19 | if (query) {
20 | setHidden(!data.keywords.includes(query))
21 | } else {
22 | setHidden(false)
23 | }
24 | }, [query, complexity, data.keywords, data.complexity]),
25 | [isHidden]
26 |
27 | return (
28 |
29 |
30 |
31 |
32 |
33 |
42 |
43 | {data.category}
44 |
45 |
{data.description}
46 |
Usage:
47 |
48 | {data.usage.map((usage, index) => {
49 | {
50 | return (
51 |
60 |
61 |
62 |
15 |
16 |
17 | {usageCode}
18 |
20 |
21 |
{usage.description}
22 |
21 |
26 |
28 |
29 | Copied
30 |
31 |
32 | )
33 | }
34 |
35 | export default CopyButton
36 |
--------------------------------------------------------------------------------
/src/components/Footer/index.js:
--------------------------------------------------------------------------------
1 | import React from "react"
2 | import Link from "next/link"
3 |
4 | const Footer = () => {
5 | return (
6 |
7 |
8 | Made with ♥ by{" "}
9 |
16 |
{title}
12 |
35 |
47 | {data.map((item, index) => {
48 | return (
49 |
50 | {item}
51 |
52 | )
53 | })}
54 |
55 |
56 | )
57 | }
58 |
59 | export default Search
60 |
--------------------------------------------------------------------------------
/src/pages/_app.js:
--------------------------------------------------------------------------------
1 | import "bootstrap/dist/css/bootstrap.css"
2 | import "../../styles/globals.css"
3 | import "../../styles/home.css"
4 | import "../../styles/search.css"
5 | import "../../styles/card.css"
6 | import "../../styles/code.css"
7 | import "../../styles/copybutton.css"
8 | import "../../styles/footer.css"
9 |
10 | function MyApp({ Component, pageProps }) {
11 | return Failed to load
43 |
44 | // Handle the loading state
45 | if (!data) return
54 |
55 |
60 |
61 |
62 |
63 | {commandsList.map((card, index) => {
64 | {
65 | return (
66 |
76 |
77 |
78 |
79 |
16 |