https://github.com/gregor-vm/devshortcut

This website was made to be a simple but fast visualizer of examples, allowing users to view, copy or download local examples or GitHub examples that are included and organized in the project, but users can also provide a GitHub URL to see any other example or repository on their own.
https://github.com/gregor-vm/devshortcut

css express html nodejs preact tailwindcss typescript

Last synced: 2 months ago
JSON representation

This website was made to be a simple but fast visualizer of examples, allowing users to view, copy or download local examples or GitHub examples that are included and organized in the project, but users can also provide a GitHub URL to see any other example or repository on their own.

• Host: GitHub
• URL: https://github.com/gregor-vm/devshortcut
• Owner: Gregor-VM
• License: mit
• Created: 2024-02-04T21:57:42.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2024-08-13T20:17:03.000Z (4 months ago)
• Last Synced: 2024-10-01T04:03:35.407Z (3 months ago)
• Topics: css, express, html, nodejs, preact, tailwindcss, typescript
• Language: TypeScript
• Homepage: https://devshortcut.vercel.app
• Size: 2.59 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# DevShorcut 

![DevShorcut Logo](/public/apple-icon-120x120.png)

> Disclaimer: This website was made with educational purposes, the project is under the MIT License.

This website was made to be a simple but fast visualizer of examples, allowing users to view, copy or download local examples or github examples that are included and organized in the app but users can also provide a github url to see any other example or repository on their own.

### Website

The project is live [here!]()

### How can I added an example?

To add en example go to the file _src/utils/examples.ts_ and add your example on the list of examples, make sure that all tags exists or create them if neccesary, also make sure that the example title is unique.

Adittionally, if you want to add a local example, make sure to provide the _folder_ property with the name of the folder that contains your example code in the examples folder and be sure that the tabs names correspond to each tab on you code example.

### How to contribute?

If you are willing to contribute I highly appreciated, as I'd probably not have many contributors, you can simple fork the project and make me a pull request. You can also raised an issue if you identify any problems or if you have a suggestion that will make this project better any contribution is well received :) 

#### LICENSE 📜

This project is under the [MIT License](/LICENSE).

Don't forget to leave a star 🌟