From 6ea8d2353f581dcbd83c2e2ec144dba513bdba3b Mon Sep 17 00:00:00 2001 From: Marc Taylor <marta873@student.liu.se> Date: Mon, 8 Apr 2024 10:08:51 +0000 Subject: [PATCH] Update README.md --- README.md | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 4ce06be..9956f0e 100644 --- a/README.md +++ b/README.md @@ -56,7 +56,28 @@ Every project is different, so consider which of these sections apply to yours. Choose a self-explaining name for your project. ## Description -Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors. +The project is a website where users should be able to upload their owned costumes, users should also be able to rent a costume for a specific amount of money. The website is specifically made for Students in Linköping where it would facilitate the process of getting costumes for theme parties. + +## Specification +A more detailed specification of the project + +### Functional +- A User should be able to upload a Clothing item. +- A User should be able to buy/rent a Clothing item for a specified time. +- A clothing item should contain a name, price, image and a size. +- A clothing item that is rented should show what dates it is available/unavailable. +- A user should be able to filter clothing by renting/selling. +- A User needs a name, email, password, valid phone number. +- Clothing can be categorized with premade categories. +- There should be a functional pay system. +- There should be shopping cart where user can add several Clothing items. +- In the shopping cart the user should be able to delete items and change the date of renting. +- The website should be responsive for both phones and computers. + +### Technologiacal +- Project will be done by using react framework. +- The backend will be developed using Django. +- The database will be hosted locally with a possibility of hosting it using Firebase. ## Badges On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge. -- GitLab