Skip to content

ZackBradshaw/ikigAI

Repository files navigation

Ikigai Achievement App with AI Assistant

Ikigai Logo

Ikigai is an interactive self-help app inspired by the Japanese concept of finding one's purpose in life. It aims to assist users in discovering and achieving their "Ikigai" through a blend of AI-driven guidance and community support. The backend is built with Python, while the frontend utilizes Next.js and Tailwind CSS.

Project for hackathon on lablab ai. Link: https://lablab.ai/event/autonomous-agents-hackathon/agora-spartans/ikigai

Table of Contents

Getting Started

These instructions will help you set up the project on your local machine for development and testing purposes.

Prerequisites

  • Docker
  • Docker Compose

Installation

  1. Clone the repository to your local machine:
git clone https://github.com/ZackBradshaw/ikigAI.git
cd ikigAI/app
  1. Build the Docker image:
docker-compose build

Running the App

  1. Start the Docker containers:
docker-compose up
  1. The app will be running at http://localhost:5000.

Features

  • User Profile Module: Collects user's interests, skills, passions, and values.
  • Ikigai Discovery Module: Helps users find the intersection of what they love, what they are good at, what the world needs, and what they can be paid for.
  • Goal Setting Module: Allows users to set short-term and long-term goals related to their Ikigai.
  • AI Assistant Module: Provides timely notifications, reminders, and guidance.
  • Progress Tracking Module: Tracks user's progress towards achieving their Ikigai.
  • Community Module: Connects users with a community of like-minded individuals.

... (rest of the existing content)

Contributing

If you are interested in contributing to the Ikigai project, feel free to fork the repository, create a new branch for your work, and open a pull request. For major changes, please open an issue first to discuss what you would like to change.

License

MIT

Contact

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •