Skip to content

Latest commit

 

History

History
118 lines (80 loc) · 3.85 KB

README.md

File metadata and controls

118 lines (80 loc) · 3.85 KB

📒 Simple Emotion Diary 📒

Simple Emotion Diary Service Made for React Study!

⭐️✏️ Website Link 📒

Table of Contents
  1. About The Project
  2. Getting Started
  3. Contributing
  4. Contact

About The Project

📒🖍️ Emotion Diary is a simple web application where users can record and manage their emotions. Users can write, edit, delete diary entries, and view them organized by month.

✨ Features

1. Create New Diary: Users can create new diary entries to record their emotions and experiences.
2. Edit Diary: Users can edit existing diary entries to update their emotions and content.
3. Delete Diary: Users can delete unwanted diary entries from their records.
4. View Diary Details: Users can view their diary entries organized by month to track their emotions over time.

🗒️ Components

  • App.js
    The main component responsible for managing the overall application state and routing.

  • DiaryEditor.js
    Component for creating and editing diary entries.

  • DiaryItem.js
    Component representing individual diary entries.

  • DiaryList.js
    Component displaying a list of diary entries with filtering and sorting options.

  • EmotionItem.js
    Component representing individual emotion options.

(back to top)

🔨 Built With


(back to top)

Getting Started

This is an instructions of setting up my project locally in your computer.
To get a local copy up and running follow these simple example steps.

⚙️ Installation

  1. Please clone the repository and then run the following command to install dependencies:

    npm i
  2. After confirming the installation of all dependencies, please run the following command to start the React application:

    npm run start

(back to top)

Contributing

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

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

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

(back to top)

Contact

Project Github

(back to top)