docs: add initial project documentation for MyFavStuff personal curation site
This commit is contained in:
parent
b61840fed8
commit
c1c6178d4d
10
Inputs/Design notes.md
Normal file
10
Inputs/Design notes.md
Normal file
@ -0,0 +1,10 @@
|
|||||||
|
## **Minimalist Style**
|
||||||
|
|
||||||
|
- The design is clean and uncluttered, with ample white space between elements to ensure readability and focus on the items themselves.
|
||||||
|
|
||||||
|
## **Typography**
|
||||||
|
|
||||||
|
- Bold, sans-serif fonts are used for titles and headers, ensuring clarity and modern aesthetics. Smaller fonts are used for subtext, maintaining hierarchy in information presentation.
|
||||||
|
|
||||||
|
## **Colors**
|
||||||
|
- F8F9FA ; E9ECEF ; DEE2E6 ; CED4DA ; ADB5BD ; 6C757D ; 495057 ; 343A40 ; 212529
|
||||||
BIN
Inputs/MyFavStuff 2025-04-05-1203.png
Normal file
BIN
Inputs/MyFavStuff 2025-04-05-1203.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 342 KiB |
73
Inputs/Product Vision MyFavStuff.md
Normal file
73
Inputs/Product Vision MyFavStuff.md
Normal file
@ -0,0 +1,73 @@
|
|||||||
|
# What
|
||||||
|
I want to create a site that curates all the stuff I really enjoyed. It should be very broad and the data model should allow for many kind of stuff I liked. Hereunder a few examples.
|
||||||
|
- Books
|
||||||
|
- Movies
|
||||||
|
- TV series
|
||||||
|
- Restaurants
|
||||||
|
- Food
|
||||||
|
- Wines
|
||||||
|
- Recipes
|
||||||
|
- Music
|
||||||
|
- Albums
|
||||||
|
- Songs
|
||||||
|
- Concerts
|
||||||
|
- Art
|
||||||
|
- Musea
|
||||||
|
- Expositions
|
||||||
|
- Games
|
||||||
|
|
||||||
|
# Functionalities
|
||||||
|
## Now
|
||||||
|
As an admin being able to add items to my list so that I can remember what I liked or disliked.
|
||||||
|
The items that I should first be able to add are books, movies and tv series.
|
||||||
|
For every item that I log there should always be an option to fill in tags and a rating. The rating should be from 1 to 5.
|
||||||
|
For books I would like to be able to add the following fields:
|
||||||
|
- Title
|
||||||
|
- Author
|
||||||
|
- Url
|
||||||
|
- Picture of the book
|
||||||
|
- Publication Date
|
||||||
|
- Date read
|
||||||
|
- Genre
|
||||||
|
- Format
|
||||||
|
- Rating
|
||||||
|
- Tags
|
||||||
|
- Comments
|
||||||
|
|
||||||
|
For the movies the following fields should be present:
|
||||||
|
- Title
|
||||||
|
- Director
|
||||||
|
- Url
|
||||||
|
- Picture of the movie
|
||||||
|
- Date watched
|
||||||
|
- Genre
|
||||||
|
- Where (which platform, like Netflix, HBO Max, other,....)
|
||||||
|
- Rating
|
||||||
|
- Tags
|
||||||
|
- Comments
|
||||||
|
|
||||||
|
For the series the following fields should be present:
|
||||||
|
- Title
|
||||||
|
- Season
|
||||||
|
- Url
|
||||||
|
- Picture of the movie
|
||||||
|
- Date watched
|
||||||
|
- Genre
|
||||||
|
- Where (which platform, like Netflix, HBO Max, other,....)
|
||||||
|
- Rating
|
||||||
|
- Tags
|
||||||
|
- Comments
|
||||||
|
|
||||||
|
As an admin I should be able to see what I added to my list. The landing page should show a list of all the items I added in reverse chronological order. Each item should have its own card. Each card should show a picture (if no picture has been added it should show a generic representation), under the picture the title, the Rating and the URL. As an Admin clicking on the picture should bring you to the detailed page per item. If it's a book it should show all the attributes I listed above for the book.
|
||||||
|
|
||||||
|
## Next
|
||||||
|
As an admin I should be able to add a user. The user is defined by an email address, a (nick)name and a password. The password is stored securely in a database.
|
||||||
|
As a user I should be able to logon to the site. I should see the list of items in reverse chronological order. As a user I should be able to click on each card. Clicking on the card brings the user to the detailed view of each item. The user shouldn't be able to edit the fields.
|
||||||
|
As a user if I am on the detailed field I should be able to
|
||||||
|
## Later
|
||||||
|
|
||||||
|
First you need to sign on on the site, before being able to see anything.
|
||||||
|
When you fill in the right username and password as a regular user, you can see a list of all the items (stuff) that I like. This list should be in reverse chronological order. The last item at the top.
|
||||||
|
|
||||||
|
# Why
|
||||||
|
I want to be able to share this with friends and I don't want to use existing social networks. Since I don't like social networks. In a later stage if the friends like that system I would like to share it with people who should be able to create their own account, to generate a new community where "the algoritme" doesn't dictate what you see, but where you depend on what friends curate for you.
|
||||||
10
Inputs/Tech stack for MyFavStuff.md
Normal file
10
Inputs/Tech stack for MyFavStuff.md
Normal file
@ -0,0 +1,10 @@
|
|||||||
|
The tech stack for MyFavStuff should be based on:
|
||||||
|
- Deployments: Coolify.
|
||||||
|
- The application should be dockerized because that's how it will be deployed on Coolify.
|
||||||
|
- Frontend: Next.js with React
|
||||||
|
- Styling: Tailwind CSS + ShadCN UI
|
||||||
|
- Database: Supabase
|
||||||
|
- Authentication: basic_auth with Caddy (reverse proxy) to get started with (You shouldn't do anything about this yet)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Loading…
x
Reference in New Issue
Block a user