Skip to content

waltscode/BrimLoft

Repository files navigation

BrimLoft

Description

BrimLoft is a dynamic web application designed for hat enthusiasts. It offers users an exclusive platform to explore, register, and purchase a wide range of stylish hats. With features like user authentication, personalized profiles, and an intuitive shopping interface, BrimLoft elevates the online hat shopping experience.

Table of Contents

  1. Features
  2. Technologies Used
  3. Getting Started
  4. Usage
  5. Testing
  6. Deployment
  7. References
  8. Contributing
  9. Authors
  10. License
  11. Acknowledgments

Features

  • User Authentication
  • Personalized User Profiles
  • Product Catalog
  • Shopping Cart and Checkout

Technologies Used

  • Frontend: [HTML, CSS, JavaScript]
  • Backend: [Node.js, Express.js]
  • Database: [MySQL, Sequelize ORM]
  • Additional: [bcrypt]

Getting Started

Prerequisites

  • Node.js
  • MySQL

Installation

  • Clone the repo: git clone git@github.com:waltscode/Group6_Project_Hats.git

Environment Setup

  • Create a .env file with the following contents: DB_NAME='brimloft_db' DB_USER='your_mysql_username' DB_PASSWORD='your_mysql_password' SESSION_SECRET='your_secret'

Running the Application

  • Install dependencies and start the server: cd BrimLoft npm install npm start

Usage

  • Access the application through http://localhost:3001 in a web browser after starting the server.
  • Explore different hat categories, add items to your cart, and proceed to checkout.
  • Utilize the user authentication feature to create a personal account, log in, and manage your orders and profile.

Testing

  • Ensure all dependencies are installed by running npm install before conducting tests.
  • Run automated tests using the command npm test in your terminal. Make sure you are in the project's root directory.
  • Check the test results for passed and failed tests. Failed tests will provide information for further debugging and code refinement.

Deployment

References

Contributing

  • Contributions to E-commerce-Back-End are welcome! If you have suggestions for improvement or bug fixes, please open an issue or submit a pull request. Ensure your code adheres to the existing style for consistency. Thank you for your interest in enhancing this employee management tool.

Authors

  • Developed by a group of passionate developers committed to creating efficient and user-friendly software solutions. John Walters Nicholas Lee Stanislav Morozan Karla Wubbenhorst Sanyam Singh

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

Contacts

Acknowledgments

  • A special thank you to Program Instructor and Instructor's Assistant who provided invaluable insights and feedback throughout the development process.
  • Appreciation for the open-source community for providing the tools and libraries that made this project possible.
  • Gratitude to the team members for their hard work, innovative ideas, and collaborative spirit that drove the project to success.
  • Thanks to the early users who tested the application and provided constructive feedback, helping us to improve user experience and functionality.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors