Skip to content

Latest commit

 

History

History
82 lines (60 loc) · 4.55 KB

README.md

File metadata and controls

82 lines (60 loc) · 4.55 KB

Laravel Framework 9.52.15 - Laravel Vue3 - CRUD using Redmine REST Apis.

In this project there is an implementation of Laravel CRUD operations using Vue3 and redmine rest apis.

Note

  • This was developed and tested using windows machine.
  • While using docker-compose up if you see any error that port is not available then either change the port for that image or look for a solution to kill that running port.
  • Pagination is set to 10, so you will be able to see pagination only when your Isues count is greater the 10.
  • You might see slowness in the app this because of running it in windows using WSL. Please wait till the loader fades out.

Setup

  • Clone or download the code.
git clone https://github.com/vikasbadola/laravel-vue-redmine-crud.git
  • cd to your downloaded code cd laravel-vue-redmine-crud
  • run docker-compose build
  • run docker-compose up -d
  • rename .env.example to .env
  • go into docker containe docker exec -it laravel-vue-redmine-crud-php-1 bash
  • run composer install (if it fails, then run it again untill it completes)
  • run php artisan key:generate
  • Setup your database into .env file or create laravel-vue-crud, phpmyadmin can be accessed using http://localhost:8088/ username - root, password - password
  • Run databse migrations and seeders. Migrations can be found within database/migrations. php artisan migrate:refresh --seed

Redmine setup (This setup is mandatory to consume redmine Apis)

  • Redmine login url is below and login details are Login: admin, Password: admin, after this you will be redirected to change your password, set up the new password and login.
    http://localhost:8080/login
    

login

  • Once you are logged in, go to administrations->settings select APT tab and check Enable REST web service and Enable JSONP support and save it.

enableRestEndpoints

  • Go to projects and create a new Project. http://localhost:8080/projects/new

neProject

  • Go to Issue Statuses http://localhost:8080/issue_statuses and create one. issueStatus

  • Create Issue Priorities http://localhost:8080/enumerations/new?type=IssuePriority addPriority

  • Create issue tracker http://localhost:8080/trackers/new, select your project while creating it. addTracker

  • Copy API access key from http://localhost:8080/my/account to .env and replace with REDMINE_API_KEY apikeys

  • Within docker container run php artisan serve --host=0.0.0.0

  • Run outside container docker-compose run --rm node install

  • Now, you can access the application using url http://localhost:8000/ Issueslist

screenshots of the app and functionality

addIssue issueListPaginator IssueListNopaginator editIssue deleteIssue

Accesssing local database instead of redmine apis

  • go to .env and set USE_REDMINE_REST_APIS=false, now you can use your local databse to perform CRUD.

Running test cases

  • Within docker container run below:
.\vendor\bin\phpunit 

License

The Laravel framework is open-sourced software licensed under the MIT license.