Gitty: Git Workflow Education

Gitty is a platform to help users practice their git workflow, version control, and collaboration.

Tech Stack

Demo

Insert gif or link to demo

Contributing

Contributions are always welcome!

See contributing.md for ways to get started.

Please adhere to this project's code of conduct.

1. Create a new branch with your proposed lesson idea

2. Observe the following format for lesson creation. If you are unfamiliar with mermaidJS, I encourage you to visit their online editor

  {
    title: 'Lesson 1\nGit Basics',
    icon: 'BsGithub',
    description: 'Learn the basics of Git and how to set up an account.',
    longDescription:
      'In this lesson, we will...',
    objectives: [
      'Understand the purpose of Git and GitHub',
      'Learn the differences between Git and GitHub',
      'Discover the benefits of using Git and GitHub',
      'Set up a GitHub account',
    ],
    content: [
      {
        sectionTitle: 'What is Git?',
        sectionContent:
          'Git is a distributed version...',
      },
      {
        sectionTitle: 'What is GitHub?',
        sectionContent:
          'GitHub is a web-based platform...',
      },
      {
        sectionTitle: 'Why use Git and GitHub?',
        sectionContent:
          'Using Git and GitHub can help developers...',
      },
      {
        sectionTitle: 'Setting up Git and GitHub accounts',
        sectionContent:
          "To get started with Git and GitHub...",
      },
    ],
    exercises: [
      {
        exerciseTitle: 'Create a GitHub account',
        exerciseInstructions:
          "If you haven't already, sign up...",
      },
    ],
    chartDefinition: `
    mindmap
    root)Git(
      )Git(
        (Version Control)
        ::icon(fa fa-github)
        (Commands)
          {{Basic}}
            ))init((
            ))add((
            ))commit((
            ))status((
          {{Advanced}}
            ))log((
            )) diff((
            ))merge((
            ))pull((
            )) push((
        (Branching)
          {{Types}}
            ))master((
            ))feature((
            ))hotfix((
      )GitHub(
        (Remote Repository)
        ::icon(fa fa-cloud)
        (Features)
          {{Issues & PRs}}
            ))Issues((
            ))Pull Requests((
          {{Repository}}
            ))Forks((
            ))Stars((
            ))Watchers((
        (Collaboration)
          {{Teams & Orgs}}
            ))Teams((
            ))Organizations((
          ))Code Review((
        (Integrations)
          {{CI/CD & Actions}}
            ))CI/CD((
            ))GitHub Actions((
          {{Webhooks & Apps}}
            ))Webhooks((
`,
  },

3. Add your lesson to the array located in /pages/lessons/lessonData.js

4. Submit a Pull Request.

Run Locally

Clone the project

  git clone https://github.com/eriknewland/gitty

Go to the project directory

  cd gitty

Install dependencies

  npm install

This is a Next.js project bootstrapped with create-next-app.

Start the development server:

npm run dev
# or
yarn dev
# or
pnpm dev

Learn More

To learn more about Next.js, take a look at the following resources:

• Next.js Documentation - learn about Next.js features and API.
• Learn Next.js - an interactive Next.js tutorial.

You can check out the Next.js GitHub repository - your feedback and contributions are welcome!

Deploy on Vercel

The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.

Check out the Next.js deployment documentation for more details.