fcarli3 / message-in-a-bottle

Group homework of Advanced Software Engineering (Course of M.Sc. in Cybersecurity at University of Pisa)

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

My Message In A Bottle

Build Status Coverage Status

Directory Structure

monolith
├── app.py
├── auth.py
├── background.py
├── database.py
├── forms.py
├── lottery.py
├── __init__.py
├── badwords.txt
├── classes
│   └── __init__.py
├── templates
│   ├── add_to_blacklist.html
│   ├── blacklist.html
│   ├── calendar.html
│   ├── create_user.html
│   ├── index.html
│   ├── login.html
│   ├── lottery.html
│   ├── menu_notAuth.html
│   ├── menu.html
│   ├── message.html
│   ├── msgs_draft.html
│   ├── msgs_rcv.html
│   ├── msgs_sent.html
│   ├── recipients.html
│   ├── report_user.html
│   ├── report.html
│   ├── send_message.html
│   ├── user_info.html
│   └── users.html
├── tests
│   ├── __init__.py
│   ├── test_base.py
│   ├── test_blacklist.py
│   ├── test_calendar.py
│   ├── test_celery.py
│   ├── test_draft.py
│   ├── test_mailbox.py
│   ├── test_messages.py
│   └── test_user.py
└── views
    ├── __init__.py
    ├── auth.py
    ├── calendar.py
    ├── home.py
    ├── mailbox.py
    ├── messages.py
    └── users.py

Installation

Setup the environment

To setup the environment you have to follow these steps:

  1. Open the project in your IDE.
  2. From IDE terminal, or normal Ubuntu/MacOS terminal execute the command virtualenv venv inside project root.
  3. Now, you have to activate it, by executing the command source venv/bin/activate (you have to execute it every time you open a new terminal).
  4. You have to install all requirements, let's do that with pip install -r requirements.txt.

Run the application

To run the application, execute the following commands:

  1. Run Redis on Docker in detach mode: docker run -d -p 6379:6379 redis.
  2. Run the app: ./run.sh or set the following environment variables:
FLASK_APP=monolith
FLASK_ENV=development
FLASK_DEBUG=true
PYTHONPATH=$PWD

Run tests

To run tests in isolated environemnts it has been used Tox using tox command from the root project folder.

Output

image info

Authors

About

Group homework of Advanced Software Engineering (Course of M.Sc. in Cybersecurity at University of Pisa)


Languages

Language:Python 50.4%Language:HTML 49.4%Language:Shell 0.2%