Re-structure file
This commit is contained in:
parent
e82dfb03fc
commit
9aaae974d6
1 changed files with 53 additions and 6 deletions
59
README.md
59
README.md
|
|
@ -1,6 +1,29 @@
|
||||||
# incr
|
<div align="center">
|
||||||
|
|
||||||
A minimalist one-page Laravel + React application for tracking VWCE shares with milestone reinforcement and optional financial insights.
|
# 📈 incr
|
||||||
|
|
||||||
|
**A minimalist investment tracker for VWCE shares with milestone-driven progress**
|
||||||
|
|
||||||
|
*Track your portfolio growth with visual progress indicators and milestone reinforcement*
|
||||||
|
|
||||||
|
[](https://www.gnu.org/licenses/gpl-3.0)
|
||||||
|
[](https://www.docker.com/)
|
||||||
|
[](https://laravel.com/)
|
||||||
|
[](https://reactjs.org/)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
**[Introduction](#introduction) • [Features](#features) • [Tech Stack](#tech-stack) • [Getting Started](#getting-started) • [Development](#development) • [Contributing](#contributing) • [License](#license)**
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
## Introduction
|
||||||
|
|
||||||
|
Incr is a minimalist, one-page investment tracking application designed specifically for VWCE (Vanguard FTSE All-World UCITS ETF) shareholders. It combines the satisfaction of visual progress tracking with practical portfolio management, featuring a distinctive LED-style digital display and milestone-based goal setting.
|
||||||
|
|
||||||
|
The application emphasizes simplicity and focus, providing just what you need to track your investment journey without overwhelming complexity.
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
|
|
@ -17,7 +40,9 @@ ## Tech Stack
|
||||||
- **Styling**: Tailwind CSS 4 with shadcn/ui components
|
- **Styling**: Tailwind CSS 4 with shadcn/ui components
|
||||||
- **Deployment**: Docker with multi-stage builds
|
- **Deployment**: Docker with multi-stage builds
|
||||||
|
|
||||||
## Quick Start (Production)
|
## Getting Started
|
||||||
|
|
||||||
|
### Quick Start (Production)
|
||||||
|
|
||||||
Run the application using Docker Compose:
|
Run the application using Docker Compose:
|
||||||
|
|
||||||
|
|
@ -34,7 +59,9 @@ # Start the application
|
||||||
|
|
||||||
**Default credentials**: You'll need to register a new account on first visit.
|
**Default credentials**: You'll need to register a new account on first visit.
|
||||||
|
|
||||||
## Development Setup
|
## Development
|
||||||
|
|
||||||
|
### Local Development Setup
|
||||||
|
|
||||||
For local development with Laravel Sail:
|
For local development with Laravel Sail:
|
||||||
|
|
||||||
|
|
@ -56,13 +83,33 @@ # Run migrations
|
||||||
|
|
||||||
The development server will be available at `http://localhost` with hot reload enabled.
|
The development server will be available at `http://localhost` with hot reload enabled.
|
||||||
|
|
||||||
## Project Structure
|
### Project Structure
|
||||||
|
|
||||||
- `app/` - Laravel backend (controllers, models, services)
|
- `app/` - Laravel backend (controllers, models, services)
|
||||||
- `resources/js/` - React frontend components and pages
|
- `resources/js/` - React frontend components and pages
|
||||||
- `docker/` - Production Docker configuration
|
- `docker/` - Production Docker configuration
|
||||||
- `database/migrations/` - Database schema definitions
|
- `database/migrations/` - Database schema definitions
|
||||||
|
|
||||||
|
## Contributing
|
||||||
|
|
||||||
|
We welcome contributions to incr! Whether you're reporting bugs, suggesting features, or submitting pull requests, your input helps make this project better.
|
||||||
|
|
||||||
|
### How to Contribute
|
||||||
|
|
||||||
|
1. Fork the repository
|
||||||
|
2. Create a feature branch (`git checkout -b feature/amazing-feature`)
|
||||||
|
3. Commit your changes (`git commit -m 'Add some amazing feature'`)
|
||||||
|
4. Push to the branch (`git push origin feature/amazing-feature`)
|
||||||
|
5. Open a Pull Request
|
||||||
|
|
||||||
|
### Bug Reports
|
||||||
|
|
||||||
|
If you find a bug, please create an issue with:
|
||||||
|
- A clear description of the problem
|
||||||
|
- Steps to reproduce the issue
|
||||||
|
- Expected vs actual behavior
|
||||||
|
- Your environment details
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
GPLv3 License. See LICENSE file for details.
|
This project is licensed under the GNU General Public License v3.0 - see the [LICENSE](LICENSE) file for details.
|
||||||
Loading…
Reference in a new issue