Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ari-s-123/pdp-hw1
This is a webapp made with SvelteKit and OOP that helps you keep tracks of you generative AI prompts. You can see a of all your prompts and add and delete from the table to your heart's content. Unfortunately, you cannot upload any actual files as that would be too costly to maintain. There is no backend as this was made using the localStorage API.
https://github.com/ari-s-123/pdp-hw1
oop sveltekit
Last synced: 11 days ago
JSON representation
This is a webapp made with SvelteKit and OOP that helps you keep tracks of you generative AI prompts. You can see a of all your prompts and add and delete from the table to your heart's content. Unfortunately, you cannot upload any actual files as that would be too costly to maintain. There is no backend as this was made using the localStorage API.
- Host: GitHub
- URL: https://github.com/ari-s-123/pdp-hw1
- Owner: Ari-S-123
- License: mit
- Created: 2025-01-22T16:42:20.000Z (14 days ago)
- Default Branch: main
- Last Pushed: 2025-01-23T21:14:21.000Z (13 days ago)
- Last Synced: 2025-01-23T21:29:07.466Z (13 days ago)
- Topics: oop, sveltekit
- Language: TypeScript
- Homepage:
- Size: 130 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# [Generative AI Prompt Manager](https://ari-s-123.github.io/PDP-HW1)
## About
This is a webapp made with SvelteKit and OOP that helps you keep tracks of you generative AI prompts. You can see a of
all your
prompts and add and delete from the table to your heart's content. Unfortunately, you cannot upload any actual files as
that would be too costly to maintain. As there is no backend due to being out of scope for this homework assignment,
all the data is stored in the browser's localStorage API which is not reliable for long term storage as it can be
overwritten very easily.
### Creative Addition for Rubric
The [PromptStorageService](https://github.com/Ari-S-123/PDP-HW1/blob/main/src/solution/classes/PromptStorageService.ts)
class is the "creative addition" for the rubric. It implements the duties of a prompt manager using the localStorage
API. I didn't write the tests for this class because I would have to mock the localStorage API.
### Generative AI Usage
I used GitHub Copilot to generate some repetitive unit tests. They are marked with a comment above them in each test
file in src/tests/solution/.
## TODO
- [x] Update IPromptManager and all its users to include a text search on the inputted prompt on getFilteredPrompts.
- [x] Implement a search bar in the UI to filter prompts by text on all fields.
## UML Diagram
## Screenshots
## Setup
1. Clone Repo
2. Make sure you are using the latest Node LTS version at the time of the last commit [v22.x].
3. Run `npm i -g pnpm@latest-10` to install pnpm.
4. Run `pnpm i` to install the dependencies.
## Building
To create a production version of the app:
1. Run `pnpm build` to create an optimized production build of the app.
2. You can preview the production build with `pnpm preview -- open` and open the app in a new browser tab.
## Developing
1. Run `pnpm dev --open` to start the development server and open the app in a new browser tab.
## Testing
1. Run `pnpm t` to run the unit tests.
## Linting
1. Run `pnpm lint` to run prettier and eslint.
2. Run `pnpm format` to format with prettier.