https://github.com/taylormusolf/goalcrusher
A simple web application designed to help users set, track, and manage their personal or professional goals. The application provides the functionality to create new goals, view existing goals, update their status, and delete them if necessary.
https://github.com/taylormusolf/goalcrusher
alembic fastapi openai-api postgresql productivity python react sqlalchemy
Last synced: 5 months ago
JSON representation
A simple web application designed to help users set, track, and manage their personal or professional goals. The application provides the functionality to create new goals, view existing goals, update their status, and delete them if necessary.
- Host: GitHub
- URL: https://github.com/taylormusolf/goalcrusher
- Owner: taylormusolf
- Created: 2024-09-10T00:44:24.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-11T23:59:18.000Z (almost 2 years ago)
- Last Synced: 2025-04-07T14:47:39.120Z (about 1 year ago)
- Topics: alembic, fastapi, openai-api, postgresql, productivity, python, react, sqlalchemy
- Language: JavaScript
- Homepage: https://goal-crusher-app-d59414deaeb3.herokuapp.com/
- Size: 7.71 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
### Overview
Goal Crusher is a simple web application designed to help users set, track, and manage their personal or professional goals. The application provides the functionality to create new goals, view existing goals, update their status, and delete them if necessary. It is built with a Python backend and a JavaScript frontend to deliver a smooth user experience.
### Features
1. Add New Goals
Users can create new goals by providing a title and description.
2. View Goals
A list of all created goals can be viewed on the main page.
3. Update Goal Status
Users can update the status of each goal to:
- Not Started
- In Progress
- Completed
4. Delete Goals
Users can delete goals to keep their list organized.
#### Bonus Features
- Deployment: The app is deployed on [Heroku](https://goal-crusher-app-d59414deaeb3.herokuapp.com/).
- OpenAI API Integration: OpenAI’s API used for motivational quotes and goal suggestions.
- Notifications: Toastify used for user friendly notications of goal saving and deleting.
### Tech Stack
#### Backend
- Language: Python
- Framework: FastAPI
- Database: PostgreSQL
#### Frontend
Language: JavaScript
Framework: React
Styling: CSS/SCSS.
### Setup Instructions
1. Clone the Repository
```bash
git clone https://github.com/taylormusolf/goal-crusher.git
cd goal-crusher
```
2. Backend Setup
- Ensure you have Python installed.
- Install the required dependencies:
``` bash
pip install -r requirements.txt
```
- Start the FastAPI server
```bash
uvicorn backend.src.app:app --reload
```
3. Frontend Setup
- Navigate to the frontend directory and install the necessary dependencies:
```bash
cd frontend
npm install
npm run dev
```
4. Database Setup
- Ensure your local PostgreSQL database is up and running.
- Create a .env file in the backend folder
- Set the DATABASE_URL in the env file to point to your PostgreSQL instance.
- Run migrations:
```bash
alembic upgrade head
```
5. OpenAI API Setup
To use the OpenAI API, you need to set your API key in the .env file:
```shell
OPENAI_API_KEY=your_api_key_here
```
6. Deployment Instructions
The application is deployed on Heroku.
- For Heroku deployment:
1. Set up the required environment variables such as DATABASE_URL, OPENAI_API_KEY, and ENVIRONMENT.
2. Add build and release commands to your Procfile for running migrations and seeding the database.
3.
### Usage
After starting the backend and frontend, open your browser and visit http://localhost:3000 (or your deployment URL).
You can add, edit, delete, and track goals easily from the UI.
### Future Enhancements
Reminder Notifications for upcoming or due goals.
Social Sharing to share progress on social media.
User Authentication to allow multiple users to track their goals independently.
### Screenshots
### License
This project is licensed under the MIT License.