Vue Markdown Notes

It is a personal note generator, which you can write directly in Markdown and it will be generated in Html ✍⚙️🗒.

Table of contents

• Vue Markdown Notes
  • Table of contents
  • General info
  • Demo
  • Screenshots
  • Technologies
  • Setup
  • Usage
  • Status
  • Contact

General info

Date: May, 2021
Duration: 1 Week.

It's part of the course EscuelaVue.

Demo

You can try it using the Demo

Screenshots

Desktop index

Mobile index

Technologies

• Vue 3
• Vuex 4
• Firebase
  • Auth
  • Firestore
• Tailwindcss

Setup

1. Rename ".env.local.example" to ".env.local" and replace the values by your firebase configuration.

VUE_APP_FIREBASE_API_KEY=YOUR_KEY
VUE_APP_FIREBASE_AUTH_DOMAIN=YOUR_AUTH_DOMAIN
VUE_APP_FIREBASE_PROJECT_ID=YOUR_PROJECT_ID
VUE_APP_FIREBASE_STORAGE_BUCKET=YOUR_STORAGE_BUCKET
VUE_APP_FIREBASE_MESSAGING_SENDER_ID=YOUR_MESSAGING_SENDER_ID
VUE_APP_FIREBASE_APP_ID=YOUR_APP_ID

2. Clone/Download the repository.

git clone https://github.com/udsgit/vue-markdown-notes

3. You may have to install the packages with NPM.

npm install

4. Serve to local.

npm run serve

Usage

1. Open the link from the Demo or execute the serve with the steps above.
2. The app only works if you log in. By logging in you can create your own notes in Markdown, which will be saved and you can view them in Html. You can also filter, edit and delete them.

Status

Project is: Completed.

Since it has been part of a course, which has been completed.

Contact

Created by @Emmanuel, feel free to contact me!