Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update env.example and readme to make project easier to run ootb #469

Open
wants to merge 1 commit into
base: v2-c
Choose a base branch
from
Open

update env.example and readme to make project easier to run ootb #469

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion .env.example
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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"
11 changes: 4 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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!

Expand All @@ -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

Expand Down