diphan-source/noteplus

Create and Manage Your All notes in one place

Notes Plus

Create and Manage Your All notes in one place

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Contributing
• License
• Contact

About The Project

Notes Plus is a simple note taking app that allows you to create and manage your all notes in one place. You can create notes, edit notes, delete notes, search notes, and share notes with your friends.

Built With

• Flask
• Flask-SQLAlchemy
• Flask-Login
• Flask-WTF
• Flask-Bcrypt
• Flask-Mail
• Flask-Bootstrap
• Flask-Gravatar
• Flask-Migrate

Getting Started

To get a local copy up and running follow these simple example steps.

git clone https://github.com/kallyas/notesplus.git

Prerequisites

To run this project, you will need to install the following:

• Python 3.6 or higher
• pip
• MySQL or MariaDB or PostgreSQL

Installation

1. Clone the repo

git clone  https://github.com/kallyas/notesplus.git

2. Install Python packages

pip install -r requirements.txt

3. Create a database and update the database URI in config.py file
4. Run the following commands to create the database tables and run the app

flask db init
flask db migrate
flask db upgrade
flask run

Usage

1. Register a new account
2. Login to your account
3. Create a new note
4. Edit or delete a note
5. Search for a note
6. Share a note with your friends

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Kallyas - @kallyas

Project Link: Demo