https://github.com/scrumlens/scrumlens
Agile Retrospective Tool. Open-source, real-time, and designed to make your team's voice heard loud and clear
https://github.com/scrumlens/scrumlens
agile collaboration real-time retrospectives scrum scrum-agile scrum-board
Last synced: 4 months ago
JSON representation
Agile Retrospective Tool. Open-source, real-time, and designed to make your team's voice heard loud and clear
- Host: GitHub
- URL: https://github.com/scrumlens/scrumlens
- Owner: scrumlens
- License: agpl-3.0
- Created: 2024-07-21T07:45:05.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-30T06:43:42.000Z (about 1 year ago)
- Last Synced: 2024-08-30T12:11:44.960Z (about 1 year ago)
- Topics: agile, collaboration, real-time, retrospectives, scrum, scrum-agile, scrum-board
- Language: Vue
- Homepage: https://scrumlens.com
- Size: 1.08 MB
- Stars: 30
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Scrumlens
Agile Retrospective Tool
Retrospectives that actually move the needle.
Open-source, real-time, and designed to make your team's voice heard loud and clear
⭐️ Your star shines on us. Star us on GitHub!
> [!CAUTION]
> Project is currently in an active development stage.
> We strongly recommend using our app for familiarization purposes only at this time. This will allow you to get acquainted with the main features and capabilities of our project, without risking the occurrence of unexpected situations.
TODO: write a detailed README
## Pre-requisites
Before proceeding, ensure that your system meets the following requirements:
- [Bun](https://bun.sh/) - Build tool and runtime
- [MongoDB](https://www.mongodb.com/docs/manual/administration/install-community/) - Database
## Development
```
# Install dependencies
bun install
# Run the app
bun run dev
```
- Client available at http://localhost:3000
- Server available at http://localhost:3030
- API docs available at http://localhost:3030/swagger
### Structure
The project is monorepo with folders:
- `/apps/client` - Nuxt app
- `/apps/server` - Elysia app
## Roadmap
- [x] Private boards & invitation system
- [ ] Participants ban system
- [x] Comments system
- [x] Locking board
- [x] Polling
- [ ] Timers
- [x] Gifs in notes
- [ ] Export board data to PDF, CSV, etc.
## Follow
- News and updates on [X](https://twitter.com/anton_reshetov).
## License
[AGPL-3.0](https://github.com/scrumlens/scrumlens/blob/main/LICENSE)
Copyright (c) 2024-present, [Anton Reshetov](https://github.com/antonreshetov).