README.md

retroloop.io

Retroloop is an easy to use tool for conducting agile retrospectives

Local Development

Install dependencies

  pnpm install

Start the server

  pnpm dev

Running Tests

To run tests, run the following command

  pnpm test

To create coverage files manually, run the following command

  pnpm coverage

Deployment

To deploy this project, self-host the application using Docker or use this button to deploy the project to Railway.

Railway

The railway template will ask you for all necessary environment variables and spin up the necessary services for you.

Docker

Create a Docker container using the provided Dockerfile. You will need these 3 environment variables at the minimum:

The PostgreSQL connection string

DATABASE_URL='postgresql://yourdbconnectionurl'

When deploying to production, set the NEXTAUTH_URL environment variable to the canonical URL of your site.

NEXTAUTH_URL="https://retroloop.io"

NEXTAUTH_SECRET is used to encrypt the NextAuth.js JWT, and to hash email verification tokens

NEXTAUTH_SECRET="YOUR_NEXTAUTH_SECRET"

Tech Stack

• NextJS
• React
• Radix UI
• TypeScript
• TailwindCSS
• tRPC
• Prisma
• PostgreSQL

Feedback

If you have any feedback, please open an issue or reach out at [email protected]

License

Retroloop is open-source under the GNU General Public License Version 3 (GPLv3) or any later version. See LICENSE for more detail.