Skip to content

Simply Simple Notes

This is a simple application that stores notes in a SQLite file. This project is meant to be used as a demo to display some of the Gitlab's Secure features.

To get started on giving a demo see the Running a Secure Demo section. If you want to create Vulnerabilities to showcase, checkout the Creating Vulnerabilities Documentation.

In order to setup this project in your own space, checkout the Usage Guide.

The application can be accessed in production by visting http://35.222.154.107.nip.io/notes.

Requirements

  • Python
  • Pip

Installation

  1. Always use a virtual environment to keep the environment isolated and consistent: bash virtualenv venv source venv/bin/activate
  2. Install the Dependencies: bash pip install -r requirements.txt

Running

If running locally, you can start up the application by running the following:

$ python run.py
* Running on http://0.0.0.0:5000/ (Press CTRL+C to quit)

Usage

The application consists of a simple UI that allows notes to be read, deleted, and added to a database. The database is shared between all appliaction users.

The application will display all the notes at the home screen. It will also allow adding a note, which adds it to the end of the list, a note can also be deleted by id.

Note: You can also use the API describe in API Guidelines