Secure Bookshop Website

Project Description

Welcome to the Secure Bookshop project! This repository contains the code for a bookshop website with Multi-Factor Authentication (MFA) implemented for enhanced security. The project is primarily developed using JavaScript, with additional components in HTML, Python, and CSS.

Table of Contents

• Quickstart
• Installation
• Usage
• Contributing
• Project Structure
• License

Quickstart

For a quick start, refer to the getting started guide for more information on how to use Materialize CSS, which is used in this project.

Installation

To set up the project locally, follow these steps:

1. Clone the repository:

   git clone https://github.com/Jakee4488/BookShop2-6005-secure-v2.git
   cd BookShop2-6005-secure-v2

2. Install dependencies:

   npm install

3. Run the project:

   npm start

Usage

To use the Secure Bookshop website:

1. Navigate to the home page to view available books.
2. Use the search bar to find specific books.
3. Add books to your basket and proceed to checkout.
4. Register and log in to complete your purchase.

Contributing

Thank you for your interest in contributing to the project! Contributions help resolve rare bugs, add new features, polish the code, and improve the documentation.

Guidelines for Contributing

• Compare against the development branch when creating a pull request to allow time for testing and modification before merging into the stable master branch.
• Ensure that Travis CI builds and verifies all pull requests. If your pull request causes the build to fail, please resolve any issues by adding additional commits.
• Create a JSFiddle to demonstrate your code changes if possible, as this greatly helps with feedback.
• Fully test your changes and anticipate edge-case behavior.
• Keep your codebase up-to-date with the origin to avoid falling behind.

Project Structure

Key files and directories in this project include:

• README.md: This file.
• app/static/markdownEditor: Contains the Markdown Editor files.
• app/static/materialize: Contains Materialize CSS files.
• app/templates: Contains HTML templates for the application.
• gulpfile.js: Gulp tasks for building and minifying assets.

License

This project is licensed under the MIT License.

Feel free to let me know if you would like to add or modify any sections.

You can update your README.md file with this improved version.