Weekly Achievement Report (WAR) Generator

A comprehensive solution designed to automate the generation of weekly accomplishment reports based on Clockify data.

Report Bug · Request Feature

About The Project

The Weekly Achievement Report (WAR) Generator is a specialized tool created to streamline the process of generating weekly reports by automating data retrieval from the Clockify API and formatting it into a standardized Excel report. This application is designed to simplify the process of generating weekly employee reports for our company, reducing manual effort and ensuring that accurate and consistent reports are sent to our HR manager each week.

Features

• Google API Integration: Seamlessly integrates with Google Drive API to automate the storage and management of generated reports.
• Real-Time Email Sending: Automatically sends generated reports to HR or other stakeholders instantly after creation.
• Dynamic Components: Utilizes dynamic UI components that adapt based on user input and data.
• State Management: Employs state management to maintain application state and ensure data consistency across components.
• Error Handling and Notifications: Implements robust error handling with real-time notifications to alert users of any issues during report generation or data retrieval.
• Slack Webhook Integration: (Planned) Will enable automatic sending of reports to designated Slack channels.

Built With

This project was developed using the following technologies:

• Nuxt 3
• TypeScript
• Shadcn
• Tailwind CSS
• Pinia
• Clockify API Documentation
• Google Drive API Documentation
• Vercel

Getting Started

To set up the WAR Generator locally, follow these steps:

Prerequisites

Ensure you have npm installed:

npm install npm@latest -g

Installation

1. Clone the repository:

   git clone https://github.com/code-jas/war-generator.git

2. Install the NPM packages:

   cd war-generator
   npm install

3. Set up your environment variables:

   cp .env.example .env

   Replace the placeholder values in .env with your actual configuration.

4. Run Development Server:

   npm run dev

Roadmap

• Google API Integration
• Real-Time Email Sending
• Dynamic Components
• State Management
• Error Handling and Notifications
• Slack Webhook Integration

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this project better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Contact

Email - [email protected]

Project Link: https://github.com/code-jas/war-generator