eriknewland/gitty

Repository files navigation

Screen Shot 2023-05-07 at 7 03 05 PM

Insert gif or link to demo

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: 'Bs',
    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 ',
      'Learn the differences between Git and ',
      'Discover the benefits of using Git and ',
      'Set up a  account',
    ],
    content: [
      {
        sectionTitle: 'What is Git?',
        sectionContent:
          'Git is a distributed version...',
      },
      {
        sectionTitle: 'What is ?',
        sectionContent:
          ' is a web-based platform...',
      },
      {
        sectionTitle: 'Why use Git and ?',
        sectionContent:
          'Using Git and  can help developers...',
      },
      {
        sectionTitle: 'Setting up Git and  accounts',
        sectionContent:
          "To get started with Git and ...",
      },
    ],
    exercises: [
      {
        exerciseTitle: 'Create a  account',
        exerciseInstructions:
          "If you haven't already, sign up...",
      },
    ],
    chartDefinition: `
    mindmap
    root)Git(
      )Git(
        (Version Control)
        ::icon(fa fa-)
        (Commands)
          {{Basic}}
            ))init((
            ))add((
            ))commit((
            ))status((
          {{Advanced}}
            ))log((
            )) diff((
            ))merge((
            ))pull((
            )) push((
        (Branching)
          {{Types}}
            ))master((
            ))feature((
            ))hotfix((
      )(
        (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((
            )) Actions((
          {{Webhooks & Apps}}
            ))Webhooks((
`,
  },
  1. Add your lesson to the array located in /pages/lessons/lessonData.js

  2. Submit a Pull Request.

  git clone https://.com/eriknewland/gitty
  cd gitty
  npm install

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

npm run dev
# or
yarn dev
# or
pnpm dev

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

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

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.

About

Git Workflow Education

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published