https://github.com/addono/fridgetory
Track things you have in your freezer!
https://github.com/addono/fridgetory
Last synced: 8 months ago
JSON representation
Track things you have in your freezer!
- Host: GitHub
- URL: https://github.com/addono/fridgetory
- Owner: Addono
- License: mit
- Created: 2020-05-13T07:49:05.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2024-12-13T14:14:02.000Z (over 1 year ago)
- Last Synced: 2024-12-27T00:27:25.743Z (over 1 year ago)
- Language: TypeScript
- Homepage: https://fridgetory.now.sh
- Size: 2.87 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 40
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
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](https://fridgetory.now.sh). It's deployed to [Vercel](https://vercel.com) and a Postgres database provided by [AlwaysData](https://alwaysdata.com).
_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!
[](https://gitpod.io/#https://github.com/Addono/Fridgetory)
### Local
Install dependencies:
```bash
yarn
```
Prepare environment variables, the defaults should work fine if you are going to use Docker Compose in the next step.
```bash
cp prisma/.env.template prisma/.env
```
Start a Postges database:
```bash
docker-compose up -d
```
Run database migrations and generate the client:
```bash
yarn prisma:migrate && yarn prisma:generate
```
Then to run the development server in a different shell:
```bash
yarn dev
```
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
## Deployment
### Heroku
We support one-click deployments using Heroku. Go on, try it!
[](https://heroku.com/deploy?template=https://github.com/Addono/Fridgetory/tree/main)
### Locally
Install dependencies:
```bash
yarn install --frozen-lockfile
```
Build the application:
```bash
yarn build
```
Migrate database if there are still pending migrations:
```bash
yarn prisma:migrate
```
Start the application, you can use the `PORT` environment variable to expose the application on a different port:
```bash
yarn start
```
## Configuration
### Sentry
1. Login to Sentry, create a new project and copy the DSN, which looks something like: `https://7dbfb251580f457a971c4f8be71eccc1@o156197.ingest.sentry.io/5525232`
2. As part of your deployment, set the `NEXT_PUBLIC_SENTRY_DSN` environment variable to this value.