Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/soulsam480/furikaeru
A small app to discuss retrospective while being Anonymous. Create public/private boards with a simple kanban board interface and realtime changes. Flexible, simple and free.
https://github.com/soulsam480/furikaeru
expressjs postgres retro typescript vue vuejs websockets
Last synced: 3 months ago
JSON representation
A small app to discuss retrospective while being Anonymous. Create public/private boards with a simple kanban board interface and realtime changes. Flexible, simple and free.
- Host: GitHub
- URL: https://github.com/soulsam480/furikaeru
- Owner: soulsam480
- License: mit
- Archived: true
- Created: 2021-06-15T09:32:12.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2021-12-09T02:59:43.000Z (about 3 years ago)
- Last Synced: 2024-09-26T01:33:34.152Z (3 months ago)
- Topics: expressjs, postgres, retro, typescript, vue, vuejs, websockets
- Language: Vue
- Homepage: https://furikaeru.sambitsahoo.com
- Size: 2.16 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
Furikaeru
> A look back
A small app for discussing retro while being `Anonymous`. Create public/private boards with a simple `kanban` baord interface and `realtime` changes. Built with a smooth and approachable UI, Furi is is more than an app for discussing retro. See releases [here](https://github.com/soulsam480/furikaeru/releases)
### Status
- Hosted -> https://furikaeru.sambitsahoo.com
- Development -> v0.0.1 (Might be the last release of Furikaeru)
- Roadmap board -> [Don't spam please!](https://furikaeru.sambitsahoo.com/Furi_feature_board--c32276c9-d259-409a-9663-b5fdbbbcf997)
> __Visit__ [Furi component lib readme](./lib/README.md)
> __npm__ https://www.npmjs.com/package/furikaeru
#### Features
Current:
- Create/delete Boards
- Add/Edit/remove Cards
- Vote on cards
- Comment on cards
- Column color customization
- Private boards
- Board archive/restore
- Focus mode
- Keyboard shortcuts
Projected:
- Add comment edit
- Add more in the public [feature board](https://furikaeru.sambitsahoo.com/Furi_feature_board--c32276c9-d259-409a-9663-b5fdbbbcf997)
#### Furi component library
At the heart of `Furikaeru`, there is a standalone `vue 3` component library. There are only a few components, which are being used repeatedly throughout the app. It was designed on the basis of the project needs but has room for customisations. To view or use the components have a look [here](./lib).
#### Stack
API:
- Postgres
- TypeORM
- Expressjs
- SocketIo
- Passport (Google OAuth2)
- TypeScript
APP:
- Vue 3
- Vite
- Vue router
- Pinia
- SocketIo client
- Iconify
- Purge icons
- TypeScript
#### Run it lcally
> You need to have yarn installed as this repo is a `Yarn Workspace`.
- Clone/fork repo
```bash
yarn # install deps
```
- Add `env` variables.
```bash
# APP
VITE_WSS # Socket endpoint -> ws://localhost:3000
VITE_API # REST endpoint -> http://localhost:3000/furikaeru
#API
REFRESH_TOKEN_SECRET
ACCESS_TOKEN_SECRET
GCLIENT_ID
GCLIENT_SECRET
GAUTH_REDIRECT
# create a postgres db and add it here
# the DB port is hardcoded to 5432 and an extra env variable can be added to change it
PGRES_USER
PGRES_PASS
PGRES_HOST
PGRES_DB
```
- Run
```bash
yarn dev # devserver
yarn build # build
```
Any contributions are welcome. reach me on [[email protected]](mailto:[email protected])