Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/archetipo95/gratitude-jar


https://github.com/archetipo95/gratitude-jar

authentication countdown-timer dark-mode frontend github-login google-login gratitude javascript mindfulness nuxt nuxtjs supabase tailwindcss typescript vue vue-components vuejs web-development webapp

Last synced: about 17 hours ago
JSON representation

Awesome Lists containing this project

README

        

# ![Gratitude Jar Logo](https://raw.githubusercontent.com/Archetipo95/gratitude-jar/refs/heads/main/app/public/favicon.ico) Gratitude Jar

Welcome to **Gratitude Jar**, a delightful web application built with Nuxt.js that allows you to capture and reflect on moments of gratitude throughout the year. Whether you're looking to embrace mindfulness or simply want a space to record weekly reflections, this app is your perfect companion.

## Features

- **Weekly Reflections**: Add a message each week to capture what you're grateful for.
- **Countdown Timer**: Keep track of the time remaining until the end of the year.
- **Dark Mode**: Switch between light and dark themes for a comfortable viewing experience.
- **Authentication**: Log in with GitHub or Google to secure your messages.

## Project Structure

The project is organized as follows:

```
/project
├── app
│ ├── assets
│ ├── components
│ ├── composables
│ ├── layouts
│ ├── pages
│ ├── public
│ └── utils
├── server
└── types
```

## Getting Started

### Prerequisites

Ensure you have Node.js installed. The project uses Node version specified in `.nvmrc`.

### Setup

Clone the repository and install dependencies:

```
# Clone the repository
git clone https://github.com/Archetipo95/gratitude-jar.git

# Navigate into the project directory
cd gratitude-jar

# Install dependencies
bun install
```
### Development Server

Start the development server on `http://localhost:3000`:

```
bun run dev
```

### Building for Production

Build the application for production:

```
bun run build
```

Locally preview production build:

```
bun run preview
```

## Tech Stack

- **Nuxt.js**: A powerful Vue.js framework.
- **Nuxt UI 3**: Tailwind CSS 4, Nuxt Fonts, Nuxt Icons for a sleek UI.
- **Supabase**: Backend as a Service for authentication and database.

## Roadmap

- **Encryption**: Implement end-to-end encryption for messages.
- **Reminders**: Send weekly summary emails.
- **Cheer Me Up**: Add motivational content.
- **Groups**: Enable shared lists for group gratitude.
- **Testing**: Comprehensive tests for all features.
- **Storybook**: Integrate Storybook for component testing.
- **Internationalization**: Support multiple languages.
- **Account Deletion**: Allow users to delete their accounts.

## License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more information.

---

Made with ❤️ by [Martin](https://github.com/Archetipo95). Explore the wonders of gratitude and make each week count! ✨