From 8c04607d06e2ff00ab1a650a25d671491489e224 Mon Sep 17 00:00:00 2001 From: Chuck Dries Date: Wed, 14 Feb 2024 18:39:33 -0800 Subject: [PATCH] update env.example and readme to make project easier to run --- .env.example | 8 +++++++- README.md | 11 ++++------- 2 files changed, 11 insertions(+), 8 deletions(-) diff --git a/.env.example b/.env.example index e00c4fc..1f4c138 100644 --- a/.env.example +++ b/.env.example @@ -12,7 +12,8 @@ # Drizzle # Get the Database URL from the "prisma" dropdown selector in PlanetScale. # Change the query params at the end of the URL to "?ssl={"rejectUnauthorized":true}" -DATABASE_URL='mysql://YOUR_MYSQL_URL_HERE?ssl={"rejectUnauthorized":true}' +# DATABASE_URL='mysql://YOUR_MYSQL_URL_HERE?ssl={"rejectUnauthorized":true}' +DATABASE_URL='./sqlite.db' # Next Auth # You can generate a new secret on the command line with: @@ -24,3 +25,8 @@ NEXTAUTH_URL="http://localhost:3000" # Next Auth Discord Provider DISCORD_CLIENT_ID="" DISCORD_CLIENT_SECRET="" + +# Grocy connection +GROCY_BASE_URL="https://grocy.domain.com/api" +NEXT_PUBLIC_GROCY_BASE_URL="https://grocy.domain.com" +GROCY_API_KEY="generate-this-in-grocy" \ No newline at end of file diff --git a/README.md b/README.md index b4a2fb3..5471ed0 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ ## Update - May 2023 -I am painfully aware of all the issues that beset Recipe Buddy relating to Mongo not working on certain architectures, recipes not scraping properly etc, and I am almost finished with a complete rewrite using a much more modern and (hopefully) reliable stack. You can check progress out on the `t3-rewrite` branch. +I am painfully aware of all the issues that beset Recipe Buddy relating to Mongo not working on certain architectures, recipes not scraping properly etc, and I am almost finished with a complete rewrite using a much more modern and (hopefully) reliable stack. You can check progress out on the `v2-c` branch. I am also actively seeking someone who likes writing frontend code more than me to collaborate on this - please do reach out in the [Discussions](https://github.com/georgegebbett/recipe-buddy/discussions) tab if you'd like to help! @@ -22,13 +22,10 @@ Once the recipe has been extracted from the page, Recipe Buddy gives you a nice "Well gee, George, that sounds mighty swell", I hear you say, "but how does little old me go about harnessing the TypeScript goblins for my own recipe-scraping requirements?" -Well, dear reader, as I am a benevolent goblin-wrangler, I have imprisoned them in some poorly written Dockerfiles for you! All one needs to do to benefit from the gobliny goodness is as follows: - 1. Clone this repo into a directory of your choice: `git clone https://github.com/georgegebbett/recipe-buddy.git` -2. Navigate into this new directory and utter the sacred incantation: `docker-compose up` -3. Open your favourite browser like the intrepid web-o-naut you are, and visit port 4000 on the machine you ran the aforementioned command on -4. ??? -5. Profit +2. pnpm install +3. pnpm run db:push +4. pnpm run dev ## A disclaimer