Trakli is a personal income tracking application built using Laravel. The application allows users to manage and categorize their income and expenses under various groups and categories.
- Register and log in to the application
- Manage user profile information
- Create, view, update, and delete groups (e.g., Home, Office, Personal)
- Manage income categories (e.g., Sales, Salary, Gift, Bonus, Interest)
- Manage expense categories (e.g., Utilities, Transport, Electricity, Rent, Tax, Health)
- Manage parties (e.g., individuals or entities from which money comes or goes)
- Manage wallets and bank accounts (e.g., cash, bank accounts)
- Record income and expense entries with details such as date, party, description, source/target wallet, and optional attachments
- Docker
- Docker Compose
- Make
git clone git@github.com:whilesmart/trakli-webservice.gitcd trakli-webservicecp .env.example .envmake setup
make up- Start containersmake down- Stop containersmake restart- Restart containersmake test- Run testsmake lint- Check code stylemake lint-fix- Fix code style issuesmake phpmd- Runs PHP Mess Detectormake phpstan- Runs PHP Static Analyzermake format- Additional code style checksmake format-fix- Fix additional code style issuesmake migrate- Run database migrationsmake migrate-fresh- Fresh migrations (drops all tables)make seed- Run database seedersmake migrate-fresh-seed- Fresh migrations + seedersmake optimize- Optimize Laravel application (cache config, routes, views)make tinker- Open Laravel Tinker REPLmake bash- Access container bash shellmake logs- View application logsmake fix-permissions- Fix file permission issues
For detailed and explained installation steps see : INSTALLATION.md
- The application will be available at
http://localhost:8000. - API documentation will be accessible at
http://localhost:8000/docs/swagger.
To stop the Docker containers, run:
make downMIT License Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.