nofreewill42 / mynotes

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

This readme was generated by gpt-4 based on the chat that I used for creating this app. (I've only copy-pasted code so everything was implemented by chatgpt)

Project Title: Notes and Connections Visualization

Description

This project is a web-based visualization tool that uses Flask as the backend and Vis.js for the frontend. It allows users to dynamically create, edit, and visualize notes and their connections in a network graph. Users can add, edit, and connect notes interactively, and changes can be saved and managed using git for version control.

Features

  • Create, Edit, and Delete Notes: Users can add new notes, update existing ones, and delete them.
  • Manage Connections: Users can create connections between notes, edit existing connections, and view them graphically.
  • Data Persistence: Changes are saved in JSON format, and the application supports loading and saving this data.
  • Version Control: Changes can be committed to a git repository directly from the application.

Prerequisites

Before you begin, ensure you have met the following requirements:

  • Python 3.8 or higher
  • Flask
  • Git installed on your machine
  • A modern web browser

Installation

Clone the repository:

git clone https://github.com/yourusername/your-repository-name.git
cd your-repository-name

Install the required Python packages:

pip install flask
pip install GitPython

Usage

To run the application, navigate to the project directory and execute:

python app.py

The application will be available at http://127.0.0.1:5000/ in your web browser.

How to Contribute

  1. Fork the repository.
  2. Create a new branch: git checkout -b <branch_name>.
  3. Make your changes and commit them: git commit -m '<commit_message>'
  4. Push to the original branch: git push origin <project_name>/<location>
  5. Create the pull request.

Alternatively, see the GitHub documentation on creating a pull request.

License

This project is licensed under the MIT License.

Contact

If you want to contact me you can reach me at your-email@example.com.

Acknowledgements

  • Vis.js, for the dynamic data visualization capabilities.
  • Flask, for the easy to set up Python server.

About


Languages

Language:HTML 80.0%Language:Python 20.0%