xyvora / achievaim

Achiev𝘼𝙄m (pronounced "AchieveAim" or "uh-cheev-aim", IPA: /əˈtʃi:v eɪm/) is a user-friendly, scalable SaaS web application. This platform seamlessly integrates with various calendar and software applications, harnessing the power of Generative AI. Designed to assist users in crafting and tracking their SMART goals efficiently and effectively.

Achiev𝘼𝙄m

Link	Description
achievaim repo	Codebase
Achiev𝘼𝙄m Project	Project progression, tracking and management.
Achiev𝘼𝙄m Wiki	Past meeting notes, research, and documentation.
Achiev𝘼𝙄m Discord Conversation	Achiev𝘼𝙄m discussions on development, help and ideas.

---

Achiev𝘼𝙄m is a user-friendly and scalable SaaS web application. It seamlessly integrates with calendar and other software applications, leveraging the power of Generative AI to assist users in creating and tracking their SMART goals effectively.

---

Features

• Identify and create SMART goals using a click of a button.
• Generate personalized goal suggestions using OpenAI GPT API
• Track goal progress and update details from a single page
• Set goal duration, days of the week, and repetition
• Easily integrate SMART goals with automatic SMART goal events in Google or Outlook.

---

Tech Stack

• Svelte: Front-end framework for building user interfaces
• Tailwind CSS: Utility-first CSS framework
• DaisyUI: Plugin for Tailwind CSS that provides UI components
• FastAPI: A modern, fast, web-based, Python framework for building APIs
• OpenAI GPT API: Generative AI API for generating goal suggestions
• MongoDB: Database for storing goal data

---

Solution

Professionals and students struggle with setting, tracking, and achieving their goals. They often use multiple platforms to manage their tasks, appointments, and goals, leading to disorganization and inefficiency. Existing solutions may not offer seamless integration with commonly used calendar applications like Google and Outlook, making it difficult for users to synchronize their goals and tasks with their schedules. Furthermore, these solutions may not use advanced AI Large Language Models (LLMs) to provide personalized goal recommendations and progress tracking.

---

Installation

Clone the repository:

git clone [email protected]:xyvora/achievaim

Navigate to the project directory:

cd achievaim

Install the dependencies:

just install

Create a .env file in the root directory and provide the necessary environment variables:

OPENAI_API_KEY=<your-openai-api-key>

Usage Start the development server backend API:

just api

Start the frontend

just frontend-dev

Open your browser and visit http://localhost:3000 to access the app or relevant localhost address generated after running.

Contributing

Contributions are welcome! If you are interested in contributing please see our contributing guide

License

This project is licensed under the MIT License.

Feel free to modify and customize the README file according to your project's specifics.

achievaim's Issues

Make update me a patch

#167 add the ability to update a user's profile. This is currently a put request so all information has to be sent with the update, including the password. It would be nice if this was a patch request so only the needed information is updated.

Potentially change repo. name that will align with App name. Current repo name is less than optimal.

Potential names for repo change before unofficially publicized.

1. "AImarkableTargets"
2. "GoalGetterAI"
3. "SMARTGenie"
4. "TrackAI"
5. "AImpactGoals"
6. "MeasurAble"
7. "SMARTSyncAI"
8. "RelativAI"
9. "TimeBoundAI"
10. "OptimAIm"
11. "GenSMART"
12. "GaugeGoalsAI"
13. "AImbitiousPath"
14. "AImReach"
15. "SMARTSprintAI"
16. "AchievAIm"
17. "GoalGraphAI"
18. "AIspire"
19. "TrackerAI"
20. "SMARTSpectraAI".
21. "SMARTGoalGenAI"
22. "AIchieveSMART"
23. "SMARTTrackAI"
24. "GoalGaugeSMART"
25. "SMARTSpectrumAI"
26. "GenAISmartGoals"
27. "SMARTMilestoneAI"
28. "SMARTSpireAI"
29. "AiSMARTProgress"
30. "GoalGatherSMART"
31. "AISmartPath"
32. "SMARTVistaAI"
33. "SmartMoverAI"
34. "GoalGridSMART"
35. "SmartStepAI"
36. "SMARTSculptAI"
37. "GoalGuideSMART"
38. "SMARTFrontierAI"
39. "AIMappedSMART"

Frontend docker not using API path environment vairable

Add users info to the backend

Users should be able to log in and only see their own goals

Send Graphics to Paul

Upscale images before sending

Develop a feature to help users break down their goals into smaller, manageable tasks.

Graphics for website, logo and repo

Update Goals Model

When creating the Goal model I made some assumptions just to get things going that may or may not be correct, the RepeatEvery enum values for example. This should be checked and updated as appropriate.

Improving API connections from the frontend to the backend.

This may already be done. This was from the notes yesterday.

Develop a solution that integrates with systems like Google or Outlook, keeping things simple and unified.

Backend test suite getting slow

The backend test suite is getting relatively slow. I believe it is beacause of generating the password hash for users on each request is slow. This is slow on purpose for security reason so we should see if session scoping the user information will help.

Create a new branch for changing the home page to the login page.

Prioritize tasks based on current needs and project direction.

Add branch protection rules

We should add branch protection rules for PRs

Add ChatGPT calls

In the refactoring in #4 the button for ChatGPT suggestions was added, but it does not make any calls. This functionality still needs to be added back

Set up an organization on GitHub for project management.

Add Docker container for frontend

The frontend still needs a Docker container.

Update the goal display page to reflect active and completed goals before unifying the Docker functionality.

Update the project README which is currently out of date.

Finalize the minimal viable product and minimal viable segment.

Document screenshots or share links to pages containing relevant components and examples for future reference in Discord.

The user component with the different props was discussed today on the call.

Add traefik to docker

Add traefik as a docker container to manage container routing.

Update README

Once #4 merges the README.md will be slightly out of date. Some of the information will need to be updated and some can be moved to the CONTRIBUTING.md with #7

Remove default values when creating goals

With #4, when creating a new goal through the frontend, default values are used for everything but the goal name. This is most likely not what is actually and will need to be updated.

Set up GitHub Projects to manage and track project progress and issues.

Redesign the logout component.

Add validators to frontend input filelds

See here for more context.

Add login screen to the frontend

Add a screen for users to be able to login. #41 needs to be completed before this can be done.

Explore more names for the organization and product.

Add end to end testings in frontend tests

The frontend tests should test interaction with the API. To do this in CI the API will need to be started, but when I tried this initially things didn't progress past the API starting. Need to find a solution to this.

Working Demo with full MVP functionality

Tie the front and backend together

API as a service.

Share the industry best practices document mentioned in the discussion.

Add CONTRIBUTING.md file

We needs a CONTRIBUTING.md file outlining how to work with the project in development.

Rename Signup component to AccountInfo

The Signup component is used for both signups, and for updating account information so it would make since to rename it to AccountInfo to better describe it's purpose.

Task: Collate and prepare release information.

Signup component buttons need updating

Currently when I user is not signed in the Signup component displays a Sign Up button, this makes since. When A user is logged in the Sign Up button is still displayed along with a Log Out button. In this situation Sign Up doesn't make since because the user has already signed up if they can log in. Instead the Sign Up Button should be either Save or Update.

Add password to frontend user model

Currently the front end user interface does not contain password and needs to be added. Really we need to sync up the frontend and backend user information and then we can auto generate the frontend interface from the backend.

#52 (comment)

Screen flash on logout

When logging out the screen flashes for a second before redirecting to the home page. This is because in #164 I used svelte's navigate to redirect back home. navigate runs server side so in order for the redirect to happen I had to reload the page. It should be possible to redirect without this reload.

Research on new language models similar to GPT-4 for potential use in the project.

Working on front-end development base-level completion

• Create a new branch for the development of front end
• Secure routes for login and forgot password elements

Find a solution to the pre-commit mypy issue

pre-commit is throwing errors with mypy when it shouldn't. I think this is because the backend is in a subdirectory and pre-commit isn't finding the mypy pydantic plugin. See #49 for more context.

Set branches to auto delete on merge

Turning on the setting to delete branches once they are merged will prevent having old branches hanging around.

1. Click settings

2. In the general section scroll down to After pull requests are merged, you can have head branches deleted automatically. and check the Automatically delete head branches box.

Change daysOfWeek to an object in the create goal page

Currently daysOfWeek in create-goals/+page.svelte is and array of objects like:

  let daysOfWeek = [
    { name: 'Monday', selected: false },
    { name: 'Tuesday', selected: false },
    { name: 'Wednesday', selected: false },
    { name: 'Thursday', selected: false },
    { name: 'Friday', selected: false },
    { name: 'Saturday', selected: false },
    { name: 'Sunday', selected: false }
  ];

But this means you could push and pop from the list which doesn't make sence, i.e. you could end up with:

  let daysOfWeek = [
    { name: 'Monday', selected: false },
    { name: 'Tuesday', selected: false },
    { name: 'Wednesday', selected: false },
    { name: 'Thursday', selected: false },
    { name: 'Friday', selected: false },
    { name: 'Saturday', selected: false },
    { name: 'Sunday', selected: false },
    { name: 'Tuesday', selected: false },
    { name: 'Friday', selected: false },
    { name: 'Friday', selected: true },
  ];

Let's instead create an interface in types.ts since we know exactly what the keys should be:

export interface DaysOfWeek {
  monday: boolean;
  tuesday: boolean;
  wednesday: boolean;
  thursday: boolean;
  friday: boolean;
  saturday: boolean;
  sunday: boolean;
}

Then daysOfWeek in create-goals/+page.svelte would be:

let daysOfWeek: DaysOfWeek {
  monday: false,
  tuesday: false,
  wednesday: false,
  thursday: false,
  friday: false,
  saturday: false,
  sunday: false,
}

Identify plan to share codebase

Homepage flashes theme change + logged in user icons are displayed

When loading onto the homepage, the dark theme flashes and automatically shows all the available icons. After the home page loads, the theme goes to the light theme, and only the home icon is displayed.

Put release version on repo page

ThemeSelector color

Need to add a more visible font color for night mode.

Theme toggle sometimes show wrong theme

Sometimes when in light mode the dark them shows and vice versa. I think this is because it is a toggle with no state tracking. Storing the selected theme in local storage throug the svelte store will probably fix the issue.