Addono / Fridgetory

Track things you have in your freezer!

Fridgetory

A small web-app to track the things in your freezer!

Explore the docs »
View Demo · Report a Bug · Request a Feature

Demo

You can find a demo-deployment here. It's deployed to Vercel and a Postgres database provided by AlwaysData.

Note: This demo deployment uses a free-tier database with a limited amount of connections (10), the serverless nature of Vercel might exhaust this limit when deploying frequently or with a surge of users. For production deployments it is recommended to use a different pool of connections for production and preview deployments and support more database connections.

Getting Started

Gitpod

You can use Gitpod for launching a development environment in your browser with just a single click. Go on, try it!

Local

Install dependencies:

yarn

Prepare environment variables, the defaults should work fine if you are going to use Docker Compose in the next step.

cp prisma/.env.template prisma/.env

Start a Postges database:

docker-compose up -d

Run database migrations and generate the client:

yarn prisma:migrate && yarn prisma:generate

Then to run the development server in a different shell:

yarn dev

Open http://localhost:3000 with your browser to see the result.

Deployment

Heroku

We support one-click deployments using Heroku. Go on, try it!

Locally

Install dependencies:

yarn install --frozen-lockfile

Build the application:

yarn build

Migrate database if there are still pending migrations:

yarn prisma:migrate

Start the application, you can use the PORT environment variable to expose the application on a different port:

yarn start

Configuration

Sentry

1. Login to Sentry, create a new project and copy the DSN, which looks something like: https://[e-mail]/5525232
2. As part of your deployment, set the NEXT_PUBLIC_SENTRY_DSN environment variable to this value.