Skip to content

Latest commit

 

History

History
60 lines (42 loc) · 1.97 KB

README.md

File metadata and controls

60 lines (42 loc) · 1.97 KB

JournalApp

Description

JournalApp is a web application designed to allow users to keep a personal journal. The application is built using TypeScript as the primary language and Bun as the JavaScript runtime. Key technologies and libraries used in this project include React-Hook-Form for form management, Firebase for the database, Redux Toolkit for state management, and ESLint for maintaining code standards.

Features

  • TypeScript: Utilizing static typing to improve code quality and readability.
  • Bun: Using Bun as the JavaScript runtime for faster development and execution.
  • React-Hook-Form: Efficient form handling with minimal re-renders.
  • Firebase: Real-time database and authentication.
  • Redux Toolkit: Simplified state management with Redux.
  • ESLint: Ensuring consistent and clean code standards.

Installation

  1. Clone the repository:

    git clone https://github.com/yourusername/JournalApp.git

  2. Navigate to the project directory:

    cd JournalApp

  3. Install the dependencies:

    bun install

  4. Set up Firebase:

    • Create a Firebase project in the Firebase Console.
    • Set up Firestore and Authentication in your Firebase project.
    • Add your Firebase configuration to the project.

  5. Start the application:

    bun run dev

The application will be available at http://localhost:5173.

Usage

  1. Open the application in your browser.
  2. Register or log in using the Firebase authentication.
  3. Start creating, editing, and deleting journal entries.
  4. Explore the features of form handling with React-Hook-Form and state management with Redux Toolkit.

License

This project is licensed under the MIT License. For more details, see the LICENSE file.

Contact

Your Name - jesus.jimenezc.mx@gmail.com

Project Link: JournalApp - Demo