finance
finance copied to clipboard
Improve the documentation!
I've noticed that the "documentation" is totally not helpful for someone who would be new to this project (for contributing and just pulling it down and setting it up).
- [x] Create a "Setting up this project" section in the wiki to explain how to download docker, set it up, and then build this project.
- [x] Create a "Setting up your environment" section in the wiki to explain how to contribute to this project.
- [ ] Establish a "pattern" with the services and repositories that exist. (This will be a huge technical refactor)
- [x] Create a documentation page for all the "features" of this project.
- [x] Create a documentation page for explaining the conditions and how they interact.
- [ ] Create a documentation page for explaining how the alerts/events systems work (or refactor this 💩 and make a better system for the "dynamic" alerts.)
- [ ] Create a documentation page for how to setup slack, discord, and webhook alerts.
Not sure, where to place it elsewhere, but here is a short documentation to install and run it without docker:
# Clone finance and jump into the folder
git clone [email protected]:austinkregel/finance.git
cd finance
# Install dependencies
composer install
npm install
# Configure environment
cp .env.example .env
# Edit .env file to your needs
# Create storage link + generate key
php artisan storage:link
php artisan key:generate
# Run database installation
php artisan migrate
# Run css/js compilation
npm run prod
# And now run the testserver
php artisan serve
Is such kind of doku improvement welcome?
Yes! Any kind of documentation improvements are welcome!