elbrewster / sound-shelter

the Sound Shelter's donations management tool

• App Goals

• Installation Instructions

• Prisma and Database Setup

• Pictures of the App

• to view project planning and outline refer to zToDo.md in the main directory

• to view wishlist items refer to zToDo.md in the main directory

Goals

This project simulates a tool for staff working at a shelter. It's core functionalities include:

• Donation Registration: record donations and who donated
• Donation Distribution: record distributions of the shelter's inventory
• Provide a report that displays inventory amounts based on inventory type
• Provide a report for total donations given by a donor

Technologies

Installation Instructions

1. Click to open the repository.
2. Click the "Fork" button. (This will create a user copy of the repository.)
3. Open the Terminal application.
4. In Terminal, use the "cd" command to navigate to where the local repository will live.
5. In GitHub, click on the green "Code' dropdown.
6. You will see three clone options. Select "SSH" and copy the SSH key.
7. In Terminal, run "git clone [insert copied SSH key here]".
8. In Terminal, use the "cd" command to navigate into the newly created directory. Enter npm i to install dependancies.
9. Open the local repository in VS Code by typing: code .
10. Type npm run dev into the terminal and view the app in your browser at http://localhost:5173/.
11. Continue setup with database installs and running seed functions:

Prisma Setup and Seeding SQLite DataBase

0. Delete the prisma directory. All you will need is the schema_.prisma and seed.ts files at the root of the project.
1. In Terminal, run npx prisma init --datasource-provider sqlite to set up prisma folder, database and .env file
2. Copy the contents of schema_.prisma file at the root of the project into the newly created file at prisma/schema.prisma
3. Run npx prisma generate to generate Prisma Client.
4. Move the seed.ts file from the root of the project into the prisma directory.
5. Run npx prisma migrate dev --name init to create initial migration and sync database with schema in prisma.schema
6. Run npx tsx prisma/seed.ts to seed database using the seed.ts file we moved from the root and into the prisma folder
7. Run npx prisma studio to view database in the browser at http://localhost:5555/. You should now be able to view database content in reports and post successfully to database.

Screenshots

This app was made by El Brewster ✨

You can find me at: