search

TheOpenInnovator / Zen-Note

Zen Note, a customized Journal web application for users to note-down their thoughts on a daily basis and share with others or download them in a beautiful format.
https://theopeninnovator.github.io/Zen-Note/
MIT License
8 stars 16 forks source link
beginner beginner-friendly css good-first-issue hacktoberfest hacktoberfest-accepted hacktoberfest2024 html javascript journal journal-application js note open-source opensource socialmedia zennote

readme

Zen-Note

README for Zen Note Journal Web Application

Zen Note

Zen Note is an interactive journal web application that allows users to record their daily learnings in a visually appealing and easy-to-use platform. It features a professional design with light and dark modes, glassmorphism effects, and emoji-driven actions. Users can add, view, and delete learnings, and even generate beautiful snapshots of their entries with the option to download or copy them.

Features

  1. Daily Learnings Entry:

    • Users can enter their daily learnings.
    • Learnings are displayed date-wise, with the latest entries shown at the top.
    • Only one date heading per day is displayed, under which all the learnings of that day are listed.

  2. Delete Functionality:

    • Instead of a "delete" button, a bin emoji 🗑️ is displayed for each entry. Clicking it asks for confirmation before deleting the entry.

  3. Snapshot Creation:

    • Next to each entry, a snapshot emoji 📷 allows users to generate a visual snapshot of their learning.
    • Snapshots include the date, entry, and the app's name, with a glowing effect to promote the app.
    • Users can either download or copy the generated snapshot.

  4. Dark Mode:

    • The application includes a dark mode toggle (🌙/☀️). Both the main interface and snapshots adapt to light and dark modes.

  5. Responsive Design:

    • The layout adapts seamlessly to different screen sizes, ensuring a smooth experience across desktop, tablet, and mobile devices.

  6. Storage:

    • Entries are saved using localStorage so users can retrieve their previous learnings even after refreshing or closing the page.

Contributing

How to Contribute

We welcome contributions from the community. Here's how you can get involved:

1.Star the Repository

2.Create the Issue & Get Assigned Create the issue you want to work on and get assigned or Get assigned to already created issue by us.

  1. Fork the Repository: Fork the repository to your own GitHub account by clicking the "Fork" button.

  2. Create a Branch: Once you've forked the repo, create a new branch:

    git checkout -b new-feature

  3. Make Your Changes: Make sure your code adheres to our styling guide (follow the existing conventions in HTML, CSS, and JavaScript).

  4. Push Your Changes: Push the changes to your branch:

    git push origin new-feature

  5. Create a Pull Request: Go to your fork on GitHub and create a pull request. Please provide details on the changes you've made.

Installation

Prerequisites

To run this application, you need the following:

Steps

1.Star the Repository: Star this repository to access this from your profile and to share.

  1. Clone the Repository:

    git clone https://github.com/your-username/zen-note.git
cd zen-note

  2. Open the Application: Open the index.html file in your browser:

    open index.html

  3. Enjoy the Features: Start entering your daily learnings, toggle between light and dark modes, and generate beautiful snapshots of your notes!

Things to Improve

License

This project is licensed under the MIT License. See the LICENSE file for more details.

Contact

For any questions, suggestions, or feedback, feel free to contact: