[Victoria-Kim Bui]

App Structure

Table of contents

• Folder Structure
• Main Components
• Used Technologies and Dependencies
• Dependencies
• Local Development

The structure of our web application is based on Flask, Python, and SQLAlchemy to enable efficient backend processing and database interaction. In this section, we provide an overview of the folder structure, main components, and the technologies used.

Folder Structure

The folder structure of our application looks as follows:

- app/

  - dao/
  - databasetables/
  - docs/
  - static/
  - templates/

- app/databasetables/

    - education.py
    - language.py
    - project.py
    - skill.py
    - user.py
    - userProfile.py

- app/docs/

    - assets/images
      - account-sequence.png
      - ...
    - team-eval/
      - contributions.md
      - goals.md
      - improvements.md
      - peer-review.md
      - index.md
    - technical-docs/
      - api-reference.md
      - app-behavior.md
      - app-structure.md
      - data-model.md
      - design-decisions.md
      - index.md
      - image-1.png
      - ...
    - user-eval/
      - user-eval.md
    - _config.yml
    - README.md 
    - value-proposition.md

- app/static/

    - project_pictures (folder)
    - userpictures (folder)
    - account.css
    - edit_portfolio.css
    - findjobs.css
    - home.css
    - login.css
    - portfolio_logged_in.css
    - portfolio_logged_out.css
    - project_forms.css
    - project.css
    - signup.css
    - default-pfp.jpg 
    - interview.jpg
    - logo-transperent.png

- app/templates/

    - account.html
    - findjobs.html
    - home.html
    - login.html
    - portfolio_edit_view.html
    - portfolio_logged_in.html
    - portfolio_logged_out.html
    - project_forms.html
    - project.html
    - signup.html

- app/routes/

    - account.py
    - portfolio.py
    - portfolio_edit.py
    - project-forms.py
    - signup.py
    - update_profile.py

• app.py
• db.py
• models.py
• index.md
• LICENSE
• requirements.txt
• _config.yml
• init.py

Main Components

Our web application is divided into various main components to ensure clear structure and reusability:

1. Databasetables: The models define the structure of the database tables. We use SQLAlchemy to abstract the database interaction.

2. Routes Methods: The routes methods define the used methods for the endpoints of the application and handle logic behind the HTTP requests. They are organized into separate modules to enhance maintainability.

Used Technologies and Dependencies

Our web application utilizes various technologies and dependencies:

• Flask: The application is based on the Flask framework, which helps us build the web application and manage HTTP requests.

• SQLAlchemy: We use SQLAlchemy as an ORM (Object-Relational Mapping) to interact with the database. This simplifies database queries and manipulation.

• bcrypt: The bcrypt package is used for secure password hashing to ensure the security of user data.

• Flask-Bootstrap: Flask-Bootstrap is used to style the frontend of the application with Bootstrap elements, making the user interface appealing.

Dependencies

Our application uses the following main dependencies (excerpt):

• Flask: v2.2.3
• Flask-SQLAlchemy v3.0.5
• bcrypt: v4.0.1
• Flask-Bootstrap: v3.3.7.1

Exact versions can be found in the requirements.txt file.

Local Development

To develop the application locally, ensure that you have the dependencies installed by running pip install -r requirements.txt. Then use flask run to start the development server.