LukaHarambasic / digitalcards

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

digitalcards

Share digital cards with family, friends and everybody else.

Deploy to Netlify Deploy with Vercel

How to use digitalcards

Get the code

  • Fork / Clone this repository OR directly deploy it to Netlify or Vercel with the buttons above (which will also clone the repository)

Working locally

  • Install all dependencies npm install
  • Start local development server npm run dev

Generate new cards

The generated cards and categories can be found in /content

  • Create new cards with npm run generateCard / npm run gc or manually by adding new .md files to the corresponding categories
  • For the first time you will be asked how your first category should be called, e.g. 2021-christmas
  • You also can create new categories directly from the command line, choose option 1.
  • For each new card you generate you will be asked which category it belongs to

Deploying

  • If you used one of the buttons you are done - everything you publish on main will be published
  • You also can manually connect your repository to Neltify/Vercel or similar services
  • If you are here you will know what you have to do :D

Sharing

  • Get all URLs by running npm run listCards / npm run lc

Next steps

  • Add theming (open for suggestions)
  • Easy way of link sharing (UUIDs are way too long, but I also don't want to provide an overview as than everybody easily could find all other cards)

Credits

About


Languages

Language:JavaScript 43.1%Language:Vue 37.7%Language:Sass 14.2%Language:CSS 5.0%