Scratch Addons Suggestions

Hello, and welcome to my horrible code. It is I, Jazza, featuring Paul.

Let's go over some of the basics.

• This is written using SvelteKit.
• It is using Postgres as a database, with neon-db.
• It uses drizzle-orm for the ORM.
• We (well, I) use Scratch Auth for community members' authentication, and GitHub OAuth for developers' authentication.

If you would like to contribute, follow the steps below:

Contributing

• Make sure you have a suitable development environment, this includes the following:
  • Node.js
  • Docker
  • PNPM
  • A code editor
  • A GitHub OAUTH application
  • A will to live
• Fork and clone the repository
• Run pnpm i to install the dependencies
• Populate the .env file with the appropriate values, see the .env.example file for details
• Run pnpm start to start the local database, drizzle studio, and the dev server
• If this is your first time running the project, you will need to run pnpm db:push to create the database tables, and do this again whenever you make changes to the schema. I am lazy and usually drop the entire public schema and recreate it to avoid any conflicts.
  • Note: db:push needs to be run WHILE the database is running, so you will need to run it in a separate terminal.
• Profit! Unless your database is haunted, you should not see any suggestions yet. As of now, once you log in there will be a "Add mock suggestion" button, which will add a randomly generated suggestion to the database. You can also add suggestions manually through drizzle studio.
• Make your changes, and then make a pull request!!

Important other notes

• This is a horrible codebase, and I am not a professional developer. I am a student, and this is my first time using a database properly.
• I am quite literally an idiot.
• If you are an experienced developer, I will most likely take your word for changes you want to make.
• That being said, unless it's necessary, lets not change the database schema lol.
• As of 15/12/24, this project is not finished, endorsed, or even in a functional state. It is a work in progress, and no Scratch Addons org members are involved in this project (yet)

License

This project is licensed under the GNU General Public License v3.0.
You are free to use, modify, and distribute this software under the terms of the license.
See the LICENSE file for details.

Why you would want to use this code is beyond me.

Disclaimer

This project is not affiliated with, endorsed by, or approved by Scratch Addons. Yet. It's position in the scratchaddons-community organization means nothing beyond "I know people".

Now, the reason I am writing this readme...

TODO

• Add a new display mode to show more suggestions compactly
• Find a way to improve performance? I'm sure my database queries suck
• This includes streaming of data on main page, and not invalidating data on nav to account or add suggestion, i think cuz in the page load it checks for the user from locals
• ...actually allow users to add suggestions
• That includes images Jazza!! - Probably cloudinary or imagekit
• Add tips on making a good suggestion
• Turn a few of my discord friends trans
• Make suggestions be openable?
• Add manual verification for github accounts - these are for devs only
• Permissions such as admin roles
• Regret my life decisions
• Infinite scrolling?
• Add linking to other suggestions when marking as a dupe
• Add page numbers
• Add search params for things like pages, sorting, etc
• Basic image editing such as cropping or adding arrows and circles
• Add a status for what version something is being added in.
• Compact mode, remove images and less useful info