Skip to content

Latest commit

 

History

History
80 lines (56 loc) · 4.46 KB

README.md

File metadata and controls

80 lines (56 loc) · 4.46 KB
Raw

Fragrance

hero

Introduction

This is a Fragrance showcase built with Go. We hope this becomes an inspiration to you; feel free to use components of this codebase in your future projects. We built this to make ourselves happy, We hope you're happy looking at this project right now and you're making other people happy. ❤️

Requirements

  • Go - v1.11 above
  • MySQL - v5.7 above

Installation

NOTE

  • Before the fourth step, you should have created a database for this application
  • The supported database is MySQL

  • Clone this repo

    git clone https://github.com/ichtrojan/fragrance.git

  • Change directory to project directory

    cd fragrance

  • Copy .env template

    cp .env.example .env

  • Add correct database credentials to the .env file, credentials include:

    • PORT: This is the port the application will be served on
    • DB_HOST: This is your database host name/IP address
    • DB_NAME: This is the name of the database created for the application
    • DB_NAME: This is your database user
    • DB_PASS: This is your database password if any, it should be left blank if no password is configured (localhost)

  • Run application

    go run main.go

    This will serve this application on the port you specified in the .env file.

Usage

NOTE

Dashboard credentials

E-mail - cleopatra@gofragrance.xyz
Password - iloveegypt

Page Name Description Route Screenshot
Homepage 🏚 This is the first page, it links to all other pages and contains a nice paragraph / homepage
Categories ⛓ This page shows all the available fragrance Category, can be accessed by clicking the Get Started button on the homepage /categories categories
Scent 👗 This shows the available scent available in a Category, can be accessed by clicking on any of the available categories in the categories page /{category} category
Bottle 🍶 This page shows the available bottle type available for a specified scent, it can be accessed by clicking on any of the scent available on the Scent page /{category}/{scent} bottle
Checkout 💳 This page allows you to select the bottle size and quantity of you chosen fragrance based on your previous selection. It can be accessed by clicking on any of the available bottles shown in the Bottle page /{category}/{scent}/{bottle}/checkout checkout
Dashboard Login 🔐 We wanted to build a Dashboard but we didn't have the time to do so; so we made a functional Auth system /login login
Dashboard Home 🏡 The dashboard home is the page that comes up immediately you login; the only function available is the logout functionality... I wish we had time to do more 🤕 /dashboard dahboard

Performance

Performance

Contributors

Contributor Name Role Tool Language(s)
Ifeoluwasimi Olusola Designer Adobe XD ---
Muheez Jimoh Developer VSCode HTML, CSS, JavaScript & Go
Michael Trojan Okoh Developer Goland HTML, CSS & Go