Skip to content

rahuldangeofficial/EasyKeeper

Repository files navigation

EasyKeeper

EasyKeeper is a note management application that allows users to create, edit, and delete notes easily.

Setup Instructions

Follow the steps below to set up EasyKeeper on your local machine:

Prerequisites

  • Node.js (v14 or higher) - Download and install Node.js from the official website: https://nodejs.org

Installation

  1. Clone the repository to your local machine:

    git clone https://github.com/rahuldangeofficial/EasyKeeper.git
    
  2. Navigate to the project directory:

    cd EasyKeeper
    
  3. Install the dependencies using yarn:

    yarn install
    

Usage

  1. Start the development server:

    yarn start
    
  2. Open your web browser and visit http://localhost:5173(default) or as shown in terminal log to access EasyKeeper.

Building for Production

To build EasyKeeper for production, follow these steps:

  1. Run the following command:

    yarn build
    
  2. The optimized and minified production-ready files will be generated in the build directory.

Testing

  1. To run the test suite, use the following command:

    yarn test
    

Contributing

Contributions are welcome!

License

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