68 lines
1.8 KiB
Markdown
68 lines
1.8 KiB
Markdown
|
# incr
|
||
|
|
|
||
|
|
A minimalist one-page Laravel + React application for tracking VWCE shares with milestone reinforcement and optional financial insights.
|
||
|
|
|
||
|
|
## Features
|
||
|
|
|
||
|
|
- **LED-style display**: Large red digital counter showing current share count
|
||
|
|
- **Progress tracking**: Visual progress bar toward configurable milestones
|
||
|
|
- **Purchase management**: Add and track share purchases with historical data
|
||
|
|
- **Financial insights**: Portfolio value and withdrawal estimates
|
||
|
|
- **Milestone cycling**: Track progress toward multiple investment goals (1500→3000→4500→6000)
|
||
|
|
|
||
|
|
## Tech Stack
|
||
|
|
|
||
|
|
- **Backend**: Laravel 12 (PHP 8.2+) with MySQL database
|
||
|
|
- **Frontend**: React 19 + TypeScript with Inertia.js
|
||
|
|
- **Styling**: Tailwind CSS 4 with shadcn/ui components
|
||
|
|
- **Deployment**: Docker with multi-stage builds
|
||
|
|
|
||
|
|
## Quick Start (Production)
|
||
|
|
|
||
|
|
Run the application using Docker Compose:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
# Clone the repository
|
||
|
|
git clone https://codeberg.org/lvl0/incr.git
|
||
|
|
cd incr
|
||
|
|
|
||
|
|
# Start the application
|
||
|
|
docker compose -f docker/docker-compose.yml up -d
|
||
|
|
```
|
||
|
|
|
||
|
|
The application will be available at `http://localhost`.
|
||
|
|
|
||
|
|
**Default credentials**: You'll need to register a new account on first visit.
|
||
|
|
|
||
|
|
## Development Setup
|
||
|
|
|
||
|
|
For local development with Laravel Sail:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
# Install Laravel Sail
|
||
|
|
composer install
|
||
|
|
sail artisan sail:install
|
||
|
|
|
||
|
|
# Start development environment
|
||
|
|
sail up -d
|
||
|
|
|
||
|
|
# Install frontend dependencies and build assets
|
||
|
|
npm install
|
||
|
|
npm run dev
|
||
|
|
|
||
|
|
# Run migrations
|
||
|
|
sail artisan migrate
|
||
|
|
```
|
||
|
|
|
||
|
|
The development server will be available at `http://localhost` with hot reload enabled.
|
||
|
|
|
||
|
|
## Project Structure
|
||
|
|
|
||
|
|
- `app/` - Laravel backend (controllers, models, services)
|
||
|
|
- `resources/js/` - React frontend components and pages
|
||
|
|
- `docker/` - Production Docker configuration
|
||
|
|
- `database/migrations/` - Database schema definitions
|
||
|
|
|
||
|
|
## License
|
||
|
|
|
||
|
|
GPLv3 License. See LICENSE file for details.
|