noahbei / zenscribe

0 stars 0 forks source link

Zenscribe - Journal App

Zenscribe is a journaling application designed to help users capture their thoughts, feelings, and experiences in a secure and convenient way. With Zenscribe, users can create a personal account to save all their journal entries, log in using their email and password, or use Google authentication for a seamless login experience. Once logged in, users can navigate to the journal page to create new entries, rate their day, and view all their past entries on the entries page.

Features

Getting Started

To get started with Zenscribe, follow these steps:

  1. Clone the Repository: Clone the Zenscribe repository to your local machine using the following command:

    git clone https://github.com/noahbei/zenscribe
  2. Install Dependencies: Navigate to the project directory and install the dependencies using npm or yarn:

    cd zenscribe
    npm install
  3. Set Up Firebase: Create a Firebase project and set up Firebase Authentication and Firestore. Add your Firebase configuration to the project.

  4. Start the Development Server: Start the development server using npm or yarn:

    npm start
  5. Open the Application: Open your browser and navigate to http://localhost:3000 to view the Zenscribe application.

Technologies Used

Zenscribe is built using the following technologies:

Demo Video

Link to demo

Contributing

If you'd like to contribute to Zenscribe, feel free to fork the repository and submit a pull request. Contributions are always welcome!