NoteApp is a simple and efficient web application for managing notes. It provides a user-friendly interface for creating, viewing, updating, and deleting notes. This README file provides a comprehensive guide on how to set up, use, and contribute to NoteApp.
- User Authentication: Secure login and sign-up functionality.
- Create Notes: Users can create new notes with a title and content.
- View Notes: Display a list of all notes with the ability to view individual note details.
- Edit Notes: Modify existing notes.
- Delete Notes: Remove notes that are no longer needed.
- Responsive Design: Accessible on both desktop and mobile devices.
- Backend: Flask (Python)
- Frontend: HTML, CSS, Bootstrap
- Database: SQLite (for simplicity)
- Version Control: Git
Before you begin, ensure you have the following installed:
- Python 3.x
- Flask
- SQLite
- Git
-
Clone the repository:
git clone https://github.com/kedabdure/NoteApp.git cd NoteApp
-
Create a virtual environment:
python3 -m venv venv source venv/bin/activate # On Windows, use `venv\Scripts\activate`
-
Install dependencies:
pip install -r requirements.txt
-
Set up the database:
flask db init flask db migrate -m "Initial migration." flask db upgrade
-
Run the application:
flask run
-
Access the application: Open your web browser and go to
http://127.0.0.1:5000
.
-
Sign Up:
- Navigate to the sign-up page.
- Fill in your name, email, and password.
- Click the "Submit" button to create an account.
-
Log In:
- Navigate to the login page.
- Enter your email and password.
- Click the "Login" button to access your account.
-
Create a Note:
- Once logged in, click on the "Create Note" button.
- Enter the title and content of the note.
- Click "Save" to add the note to your list.
-
View Notes:
- The homepage displays a list of all your notes.
- Click on any note to view its details.
-
Edit a Note:
- While viewing a note, click the "Edit" button.
- Modify the title or content as needed.
- Click "Save" to update the note.
-
Delete a Note:
- While viewing a note, click the "Delete" button.
- Confirm the deletion in the prompt.
Contributions are welcome! If you would like to contribute, please follow these steps:
-
Fork the repository:
git fork https://github.com/yourusername/noteapp.git
-
Create a feature branch:
git checkout -b feature/your-feature-name
-
Commit your changes:
git commit -m "Add your feature"
-
Push to the branch:
git push origin feature/your-feature-name
-
Open a pull request on GitHub.
This project is licensed under the MIT License. See the LICENSE
file for more details.
- Flask documentation: Flask Docs
- Bootstrap documentation: Bootstrap Docs
- All the open-source contributors and libraries.
If you have any questions, suggestions, or issues, feel free to open an issue on GitHub or contact the repository owner.
Thank you for using NoteApp! Happy note-taking!