Skip to content

A simple note app mini-project developed with React and Tailwind CSS, featuring functionalities such as adding new notes, marking favorites, and more

License

Notifications You must be signed in to change notification settings

mobin-izadi/react-note-app

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

note app View Online Version | View Desktop Version Image 💻 | View Mobile Version Image 📱

📝 Note App

This project is a Note App developed using the React library in a Class-based format. The main goal of implementing this project was to practice and improve my skills in React.

🌟 Features

  • Add new notes: Users can create new notes.
  • Delete notes: Ability to delete existing notes.
  • Favorite notes: Users can mark their favorite notes.
  • Edit notes: Ability to edit and update note content.
  • Note creation date: Automatically records the creation date of each note.
  • Responsive design: The app is fully optimized for all screen sizes and works responsively.

🌱 Project Goal

The primary goal of this project is to enhance my skills in working with React, specifically gaining a deeper understanding of class-based components. This project has been developed as a learning exercise.

📖 Getting Started

Follow the instructions below to clone and run the project locally.

Prerequisites

Make sure you have the following installed on your machine:

  • Node.js (v14 or higher)
  • npm (for package management)

Installation

  1. Clone the Repository

    Clone the repository to your local machine using the following command:

    git clone https://github.com/mobin-izadi/react-note-app.git
  2. Navigate to the Project Directory

    Change your directory to the project folder:

    cd react-note-app
  3. Install Dependencies Install the required dependencies using npm

    npm install
  4. Running the Application To run the application locally, use the following command:

 npm start

This will start the development server, and you can view the application in your browser at http://localhost:3000.

  1. Building the Project To create a production build, use:
 npm run build

This will generate optimized static files for deployment.

📝 Note App

این پروژه یک Note App است که با استفاده از کتابخانه React و به صورت Class-based توسعه داده شده است. هدف از پیاده‌سازی این پروژه، تمرین و ارتقای مهارت‌های من در کار با React بوده است.

🌟 ویژگی‌ها

  • اضافه کردن یادداشت جدید: کاربران می‌توانند یادداشت‌های جدیدی ایجاد کنند.
  • حذف یادداشت‌ها: قابلیت حذف یادداشت‌های موجود.
  • نشان‌گذاری یادداشت‌های مورد علاقه: کاربران می‌توانند یادداشت‌های مورد علاقه خود را نشان‌گذاری کنند.
  • ویرایش یادداشت‌ها: امکان ویرایش و به‌روزرسانی محتوای یادداشت‌ها.
  • ثبت تاریخ ایجاد یادداشت: تاریخ ایجاد هر یادداشت به‌صورت خودکار ثبت می‌شود.
  • طراحی ریسپانسیو: این اپلیکیشن برای تمامی اندازه‌های صفحه‌نمایش بهینه‌سازی شده است و به‌صورت کاملاً ریسپانسیو عمل می‌کند.

🌱 هدف پروژه

هدف اصلی این پروژه، بهبود مهارت‌های من در زمینه کار با React و به‌ویژه درک عمیق‌تر مفاهیم کلاس‌بیس بوده است. این پروژه به عنوان یک تمرین آموزشی پیاده‌سازی شده است.

📖 شروع به کار

دستورالعمل‌های زیر را دنبال کنید تا مخزن را کلون کرده و پروژه را به صورت محلی اجرا کنید.

پیش‌نیازها

اطمینان حاصل کنید که موارد زیر بر روی سیستم شما نصب شده باشد:

  • Node.js (نسخه 14 یا بالاتر)
  • npm (برای مدیریت بسته‌ها)

نصب

  1. کلون کردن مخزن

    مخزن را با استفاده از دستور زیر به سیستم خود کلون کنید:

    git clone https://github.com/mobin-izadi/react-note-app.git
  2. رفتن به دایرکتوری پروژه

به دایرکتوری پروژه بروید:

cd react-note-app
  1. نصب وابستگی‌ها وابستگی‌های مورد نیاز را با استفاده از npm نصب کنید:

    npm install
  2. اجرای برنامه برای اجرای برنامه به صورت محلی، از دستور زیر استفاده کنید:

 npm start

این دستور سرور توسعه را راه‌اندازی می‌کند و شما می‌توانید برنامه را در مرورگر خود در آدرس http://localhost:3000 مشاهده کنید.

  1. ساخت پروژه برای ایجاد یک بیلد تولیدی، از دستور زیر استفاده کنید:
 npm run build

این دستور فایل‌های استاتیک بهینه‌سازی شده را برای استقرار تولید می‌کند.

About

A simple note app mini-project developed with React and Tailwind CSS, featuring functionalities such as adding new notes, marking favorites, and more

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published