Skip to content
This repository has been archived by the owner on May 24, 2023. It is now read-only.
/ PSCP-Project Public archive

Web app for keeping note & memos with markdown support built with Python Flask and support multiple users.

License

Notifications You must be signed in to change notification settings

Krit789/PSCP-Project

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Project <e>Note

Versitile, beautiful, personalized just for you.

<e>Note is more than a note it's a personal diary.

Projects Report

  Please sign-in with KMITL's Office 365 account to view our report : https://bit.ly/mypscpprojectreport

Features

  • Keep your credentials safe with hashing-salting using Scrypt algorithm.
  • Stand out with profile image with support for WebP HEIC and AVIF format.
  • You can create an infinite number of notes.
  • Markdown formatting allowed you to personalize your notes by inserting images, making your statements even clearer.
  • Support for all-session logout for additional security.
  • Notes stats for keeping track of your creation.
  • Customize your note background and choose your own profile picture.
  • With link sharing your notes can be shared with the rest of the world.

  • Setup

    Projects

    Python 3.11 is recommended to run our project. Anything older may or may not work, try at your own risk!

    Start by cloning the repository

    git clone https://github.com/Krit789/PSCP-Project.git
    

    Enter project directory

    cd PSCP-Project
    

    Installation for Ubuntu 22.04 LTS with Python 3.11

    sudo add-apt-repository ppa:deadsnakes/ppa
    sudo apt install python3.11
    sudo apt-get install python3-dev
    sudo update-alternatives --install /usr/bin/python3 python3 /usr/bin python3.11 2
    

    Then select number that represent Python 3.11

    Environments

    It's strongly recommended that you work under python virtual environment

    Make sure you have venv installed.

      Windows

    pip install virtualenv
    

      MacOS

    pip3 install virtualenv
    

      Linux

    sudo apt-get install python3.11-venv
    

    Creating virtual environment

    Windows

    python -m venv <virtual-environment-name>
    

    macOS / Linux

    python3 -m venv <virtual-environment-name>
    

    Activating virtual environment

    Windows Powershell

    Set-ExecutionPolicy RemoteSigned
    <virtual-environment-name>/Scripts/Activate.ps1
    

    Windows Command Prompt

    change directory into <virtual-environment-name>/Scripts/

    activate.bat
    

    macOS / Linux

    source <virtual-environment-name>/bin/activate
    

    Now you're set to begin the next step

    Getting all the Requirements

    pip install -r requirements.txt
    

    Running the app

    *Accessible from all network interfaces

    Windows

    For development

    python main_dev.py
    

    For production

    Powered by waitress

    python main_prod.py
    

    macOS / Linux

    For development

    python3 main_dev.py
    

    For production

    Powered by waitress

    python3 main_prod.py
    

    For mac user:

    if you encounter an address already in use error, please turn off the Airplay Reciever by open
     System Setting --> Airdrop & Handoff --> AirPlay Reciever.

    Built with

    • Bootstrap