Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/samay15jan/thoughtscape

A Journaling webapp
https://github.com/samay15jan/thoughtscape

javascript web-application

Last synced: 8 days ago
JSON representation

A Journaling webapp

Awesome Lists containing this project

README

        

# Thoughtscape - Journaling Web App

![Thoughtscape](/assets/images/Untitled%20design(2).png)

Thoughtscape is a fully responsive and secure journaling web application inspired by Reflection.app. Users can write their journals and enjoy various features, including AI responses, a 360-degree + VR lounge,some useful book recommendations, and a chatbot. The app works entirely on the client-side, and user data is encrypted with a key generated during authentication.

Check out the live demo: [https://thoughtscape.web.app](https://thoughtscape.web.app)

## Table of Contents

- [Features](#features)
- [Technologies Used](#technologies-used)
- [Setup](#setup)
- [Usage](#usage)
- [AI Responses](#ai-responses)
- [Lounge Area](#lounge-area)
- [Chatbot](#chatbot)
- [Book Recommendations](#book-recommendations)
- [User Settings](#user-settings)
- [Help and Support](#help-and-support)
- [Contributing](#contributing)
- [License](#license)

## Features

- User Authentication: Users can sign up, log in, and secure their data with client-side encryption.
- Journal Entries: Users can write and save their journal entries securely using Firestore.
- AI Responses: Users can receive AI-generated responses based on their journal entries.
- 360-Degree + VR Lounge: Users can enjoy an immersive lounge experience powered by Matterport.
- Chatbot: The app features a chatbot from Cbox to provide interactive conversations.
- Book Recommendations: Users receive personalized book recommendations based on their journal entries.
- User Settings: Users can manage their profile information and see their total journal entries.
- Help and Support: Users can submit queries and get help related to the app.

## Technologies Used

- HTML, Tailwind CSS, and Stock CSS for the frontend.
- JavaScript for client-side interactions and Firebase SDK.
- OpenAI for AI responses.
- Firebase Hosting for deployment.
- Firebase Authentication for user sign-up and login.
- Firebase Firestore for storing journal entries and user details (encrypted).
- Firebase Realtime Database for storing user information (non-sensitive).
- Matterport for the 360-degree + VR lounge experience.
- Cbox for the chatbot functionality.

## Setup

Provide instructions on how to set up the project locally. Include steps for installing dependencies, configuring Firebase, and running the application locally.

## Usage

Explain how users can effectively use the Thoughtscape journaling web app. Include instructions on creating journal entries, accessing the lounge area, interacting with the chatbot, and exploring book recommendations.

## AI Responses

Describe how the AI response feature works. Mention the AI model used, any limitations, and how user privacy is maintained during the process.

## Lounge Area

Explain the 360-degree + VR lounge experience powered by Matterport. Describe what users can explore and any unique features of the lounge.

## Chatbot

Detail the capabilities of the chatbot provided by Cbox. Mention the types of questions it can answer and any integration specifics.

## User Settings

Describe the user settings page, where users can manage their profile information and view their total journal entries.

## Help and Support

Explain how users can submit queries and get help related to the app. Mention the preferred contact method for support and approximate response times.

## Contributing

Indicate how other developers can contribute to the Thoughtscape project. Mention any guidelines for submitting pull requests and the project's development roadmap.

## License

State the license under which the Thoughtscape project is released. For example:

Thoughtscape is licensed under the [MIT License](https://opensource.org/licenses/MIT).