Skip to content

Helpful cheatsheets for popular programming languages, frameworks, and development tools, with everything you need to know! πŸ˜ŠπŸ“š

License

Notifications You must be signed in to change notification settings

megoxv/DevCheats

Repository files navigation

DevCheats πŸš€

DevCheats is a collection of cheat sheets for developers, covering popular technologies like React, Next.js, Laravel, and FilamentPHP. Each cheat sheet is written in MDX format, making it easy to integrate into documentation websites or static site generators.


Table of Contents

  1. Features
  2. Project Structure
  3. Getting Started
  4. Contributing
  5. License

Features ✨

  • MDX Format: All cheat sheets are written in MDX, combining Markdown and JSX for rich content.
  • Structured Content: Organized into categories like Basics, Hooks, Advanced, etc.
  • Code Examples Includes practical code snippets for quick reference.
  • Frontmatter Support: Each MDX file includes metadata like title, description, and tags for better organization.
  • Extensible: Easily add new cheat sheets for other technologies.

Project Structure πŸ“‚

DevCheats/
β”œβ”€β”€ content/
β”‚   β”œβ”€β”€ react/
β”‚   β”‚   β”œβ”€β”€ basics/
β”‚   β”‚   β”‚   β”œβ”€β”€ components.mdx
β”‚   β”‚   β”‚   β”œβ”€β”€ props.mdx
β”‚   β”‚   β”‚   └── state.mdx
β”‚   β”‚   β”œβ”€β”€ hooks/
β”‚   β”‚   β”‚   β”œβ”€β”€ useState.mdx
β”‚   β”‚   β”‚   β”œβ”€β”€ useEffect.mdx
β”‚   β”‚   β”‚   └── useContext.mdx
β”‚   β”‚   └── advanced/
β”‚   β”‚       β”œβ”€β”€ context-api.mdx
β”‚   β”‚       β”œβ”€β”€ render-props.mdx
β”‚   β”‚       └── higher-order-components.mdx
β”‚   β”œβ”€β”€ nextjs/
β”‚   β”‚   β”œβ”€β”€ basics/
β”‚   β”‚   β”‚   β”œβ”€β”€ routing.mdx
β”‚   β”‚   β”‚   β”œβ”€β”€ pages.mdx
β”‚   β”‚   β”‚   └── layout.mdx
β”‚   β”‚   β”œβ”€β”€ data-fetching/
β”‚   β”‚   β”‚   β”œβ”€β”€ getStaticProps.mdx
β”‚   β”‚   β”‚   β”œβ”€β”€ getServerSideProps.mdx
β”‚   β”‚   β”‚   └── getStaticPaths.mdx
β”‚   β”‚   └── advanced/
β”‚   β”‚       β”œβ”€β”€ api-routes.mdx
β”‚   β”‚       β”œβ”€β”€ dynamic-routes.mdx
β”‚   β”‚       └── middleware.mdx
β”‚   β”œβ”€β”€ laravel/
β”‚   β”‚   β”œβ”€β”€ basics/
β”‚   β”‚   β”‚   β”œβ”€β”€ routing.mdx
β”‚   β”‚   β”‚   β”œβ”€β”€ controllers.mdx
β”‚   β”‚   β”‚   └── views.mdx
β”‚   β”‚   β”œβ”€β”€ database/
β”‚   β”‚   β”‚   β”œβ”€β”€ migrations.mdx
β”‚   β”‚   β”‚   β”œβ”€β”€ eloquent.mdx
β”‚   β”‚   β”‚   └── seeders.mdx
β”‚   β”‚   └── advanced/
β”‚   β”‚       β”œβ”€β”€ middleware.mdx
β”‚   β”‚       β”œβ”€β”€ events.mdx
β”‚   β”‚       └── queues.mdx
β”‚   └── filamentphp/
β”‚       β”œβ”€β”€ basics/
β”‚       β”‚   β”œβ”€β”€ resources.mdx
β”‚       β”‚   β”œβ”€β”€ forms.mdx
β”‚       β”‚   └── tables.mdx
β”‚       └── advanced/
β”‚           β”œβ”€β”€ widgets.mdx
β”‚           β”œβ”€β”€ custom-pages.mdx
β”‚           └── notifications.mdx
β”œβ”€β”€ README.md
└── package.json

Getting Started πŸ› οΈ

Installation

  1. Clone the repository:

    git clone https://github.com/your-username/DevCheats.git
    cd DevCheats
  2. Install dependencies (if using a static site generator):

    npm install
  3. Start the development server (if applicable):

    npm run dev
  4. Open your browser and navigate to http://localhost:3000 (or the appropriate port).


Contributing 🀝

We welcome contributions! Here’s how you can help:

  1. Add New Cheat Sheets: Add cheat sheets for new technologies or expand existing ones.
  2. Fix Issues: Report or fix bugs and typos.
  3. Improve Documentation: Enhance the README or add comments to the code.

Steps to Contribute

  1. Fork the repository.

  2. Create a new branch:

    git checkout -b feature/your-feature-name
  3. Make your changes and commit them:

    git commit -m "Add your message here"
  4. Push your changes:

    git push origin feature/your-feature-name
  5. Open a pull request on GitHub.


License πŸ“œ

This project is licensed under the MIT License. See the LICENSE file for details.


Acknowledgments πŸ™

  • Inspired by the need for quick and accessible developer references.
  • Built with ❀️ by the open-source community.

Happy Coding! πŸŽ‰