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.

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

Status

• Hosted -> https://furikaeru.sambitsahoo.com
• Development -> v0.0.1 (Might be the last release of Furikaeru)
• Roadmap board -> Don't spam please!

Visit Furi component lib readme

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

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.

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

yarn # install deps

• Add env variables.

# 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

yarn dev # devserver
yarn build # build 

Any contributions are welcome. reach me on [e-mail]