https://github.com/eswat2/git-notes
build the Github Note Taker app using Vue 3 and Vite..
https://github.com/eswat2/git-notes
vitejs vuejs websockets
Last synced: 24 days ago
JSON representation
build the Github Note Taker app using Vue 3 and Vite..
- Host: GitHub
- URL: https://github.com/eswat2/git-notes
- Owner: eswat2
- Created: 2018-01-20T00:33:28.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-06-06T02:36:29.000Z (almost 2 years ago)
- Last Synced: 2025-04-09T02:12:25.846Z (about 2 months ago)
- Topics: vitejs, vuejs, websockets
- Language: Vue
- Homepage: https://git-notes-eswat2.vercel.app
- Size: 3.95 MB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# git-notes
[](https://git-notes.herokuapp.com)
I wanted to build a **Vue** version of my [**egghead-notes**](https://github.com/eswat2/egghead-notes) app and this is the result.
### Background:
I am using a custom [**WebSockets**](https://developer.mozilla.org/en-US/docs/Web/API/WebSockets_API) notes server, [**fire-notes.herokuapp.com**](https://fire-notes.herokuapp.com), to handle reading & writing notes. The repo for that can be found here: [**fire-notes**](https://github.com/eswat2/fire-notes)
### Features:
- using the latest version of **Vue3**
- converted the project to use [**Vite**](https://vitejs.dev) - _NextGen Frontend Tooling_
- refined UI elements
- mobile friendly layout
- an isolated store mutated only by actions
- a simple [**eventBus**](https://github.com/scottcorgan/tiny-emitter) which controls the flow of data thru the app
- uses [**axios**](https://github.com/mzabriskie/axios) for all api calls
- uses [**WebSockets**](https://developer.mozilla.org/en-US/docs/Web/API/WebSockets_API) to talk to a custom notes server, [**fire-notes**](https://fire-notes.herokuapp.com)
- a simple html5 pushstate mechanism
- saves last valid username to local storage
- initializes app from URL if it matches `#:username`
- otherwise it reloads last username from local storage
- a simple navigator for visited usernames
### Deployed:
This app is running on [**git-notes-eswat2.vercel.app**](https://git-notes-eswat2.vercel.app)
Running the app locally is as simple as executing the following:
```
yarn install
yarn build
yarn serve
```