Git Product home page Git Product logo

bookmarque-website's Introduction

Bookmarqué

Bookstore Project Hero Image

An online bookstore project for a group Software Engineering course. 5 members collaborated over the course of a semester using project management techniques and Agile methodology to create a full-stack MVT product.

Our Technology

  • Flask as the MVT tool and backend server
  • Jinja2 template engine
  • SQLAlchemy ORM tool
  • SCSS
  • MySQL
  • JavaScript

Setup

Flask installation for your machine:

https://flask.palletsprojects.com/en/1.1.x/installation/#installation

TLDR

  • we need to install Flask to use it
  • it is good practice to create a virtual environment when working on a Python project
    • essentially it is an isolated copy of Python so you can work on a specific project without worry of affecting other projects/installing different versions of things/etc.
  • run the following commands to create and start the venv and then install Flask

(Mac/Linux)

$ python3 -m venv venv
$ . venv/bin/activate
$ pip install Flask

(Windows)

$ py -3 -m venv venv
\> venv\Scripts\activate
$ pip install Flask
  • to exit venv, you can use deactivate from CLI
  • to gain access to the virtual environment at a later time you will need to run the activate script again

Starting a Flask Server

$ export FLASK_APP=hello.py or set FLASK_APP=hello.py
$ flask run

Now just open the port Flask prints!

See SCSS setup for how this project is run as a package instead of a module.

Flask Quickstart Tutorial (How to Run the Web Server):

https://flask.palletsprojects.com/en/1.1.x/quickstart/

SCSS/Mysql Setup

To start, you'll have to have an active mysql server on your computer. This can be done through various tools such as XAAMP, MySQL Workbench, or PHPMyAdmin, but the end result should be an active server connection. You can find the database SQL file in the repository.

To provide credentials to MySQL, enter configuration details into a config.py file using template.

Installations

pip install libsass
pip install flask_mysqldb
pip install flask_login
pip install flask-sqlalchemy
pip install cryptography

export FLASK_APP=bookmarqueapp or set FLASK_APP=bookmarqueapp
flask run

bookmarque-website's People

Contributors

benjaminmckinley avatar realuga avatar canderson8495 avatar will-mccarthy avatar karinapt7 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.