code-institute-submissions / madarame-studio Goto Github PK

This is the 4th milestone project for code institute and is mostly focused on bringing together HTML, CSS, Javascript and Python through the use of the django framework. This project is meant to simulate an e-commerce shop focusing on art, enabling users to purchase art, sign up for an account, and complete purchases using Stripe.
· Report Bug · Request Feature

Below you can see a few screenshots of the finished project.

Home Page:

Product List:

Product Detail:

Login:

Profile:

Order History:

• HTML5
• CSS
• Javascript
• Python

• SQLite - local database used during development.
• Postgres - database used post-deployment.
• AWS S3 - Database used to host static files and product images.

• GitHub - Used for version control.
• Gitpod / Gitpod Chrome extension - Used to develop the site and push the project to Github.
• Whimsical - Used to set up the wireframes at the start of the dev cycle.
• favicon.io - Used to generate the favicon files.
• fontawesome - Used to add icons across the site.
• bootstrap - Used to simplify styling.
• W3 HTML validator - Used to validate HTML code.
• W3 CSS validator - Used to validate CSS code.
• JSHint - Used to validate JS code.
• pycodestyle - Used to validate python code.

The project was deployed to Heroku using the following steps...

1. Install the required dependencies in your repository, and save them in requirements.txt by typing "pip3 freeze --local > requirements.txt".
2. Create a Procfile by typing "echo web: python app.py > Procfile" so Heroku knows what file to run.
3. Log into heroku and create a new app.
4. Give your app a unique name and select the applicaple region.
5. Go to the "Deploy" tab, and select your preferred deployment method. For this project, I used automatic deployment from github.
6. After selecting automatic deployment, enter the name of your github repository, select it from the menu when it is found, and click connect.
7. Navigate to the "Settings" tab, click "Reveal Config Vars", and apply the same variables as in your env.py file, or your IDE environment variables.
8. Now return to the "Deploy tab, scroll down, and enable automatic deployment.

• As a new user, I want to easily understand the purpose of the site.
• As a new user, I want to be able to easily navigate the site and access the content it provides.
• As a new user, I want to easily find where to sign up for an account.
• As a new user, I want to find product reviews.

• As a returning user, I want to easily log into my account.
• As a returning user, I want to be able to locate my order history and check the status of my pending orders.
• As a returning user, I want to leave reviews for products that I purchased before.

• The main colours used are #f9b87b and #7bbcf9, pastel orange and pastel blue.
• Pastel orange is meant to illicit feelings of excitement, energy and confidence for the site visitor, while pastel blue is meant to show trust and competence.

• For headers the main font will be Abril Fatface, with Rockwell and serif as fallbacks in case the font isn't being imported correctly for some reason.
• For regular text on the site, the main font will be Dosis, with Helvetica and sans-serif as fallbacks.
• Using serif fonts as headers makes it easier to read the serif fonts, as they'll be forced into uppercase which makes them easier to read, while also adding to the playfulness and creativity of the site.
• Using sans-serif on the rest of the page is to balance the playfulness with a cleaner feel as well as increasing the readability of the site.

All wireframes are in a single file and can be found here.

The ER Diagram for the project describes the relationship between the used models and can be found here

• Allow users to leave reviews on products which will dynamically affect the product ratings.
• Allow users to sign up as an artist.
• Allow artists to upload art and sell it on the page after being reviewed by the site owners.

See the open issues for a list of proposed features (and known issues).

See the closed issues for a list of the past issues.

Notable past issues:

• When creating fixtures, a typo in one of the artist models caused it to remain empty, raising an error from Django.
  Unfortunately this typo went unnoticed for around an hour where no progress was being made on the project.
• When creating the artist app and swapping the artist name and url fields from the product model,
  mutliple site refreshes as old references kept being pointed out.

Testing information can be found in it's own TESTING.md file.

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Distributed under the MIT License. See LICENSE for more information.

Lavadax - Twitter - facebook Project Link: Madarame Studio

• github.com/othneildrew: for providing the readme template.
• github.com/Code-Institute-Solutions: for filling in gaps in the readme template.
• github.com - boutique ado miniproject: for providing a solid base for this project.
• djangoproject.com: for providing documentation on the django framework.
• pixabay.com: for providing all the images and artists featured on the page.
• github.com/nar3nd3r: for providing support as my project mentor.