Giter VIP home page Giter VIP logo

gitpab's Introduction

Gitpab

License PHP version Laravel version

Who I am?

I am calculator of time spent in Gitlab by every user in period. Just mark time spent in Gitlab and build report using me.

Installation using docker

You may obtain needed project ids from gitlab Api: https://gitlab.com/api/v4/projects?private_token=your_private_token&membership=1

Clone this repo and run containers from docker folder:

git clone [email protected]:zubroide/gitpab.git
cd gitpab/docker
export host="https://gitlab.com/" \
    && export token="your_gitlab_private_token" \
    && export projects="project_id1,project_id2" \
    && docker-compose up --build app

Be patient. Loading data from Gitlab may take tens minutes at first time.

Open url http://127.0.0.1:8010
And enter
login admin@admin
password admin

Installation without docker

Create empty database in PostgreSQL.

git clone [email protected]:zubroide/gitpab.git
cd gitpab
composer install
cp .env.example .env
php artisan key:generate
php artisan vendor:publish --provider="JeroenNoten\LaravelAdminLte\ServiceProvider" --tag=assets

Edit environment variables in .env:

  • GITLAB_PRIVATE_TOKEN - is your private token from Gitlab.
  • GITLAB_RESTRICTIONS_PROJECT_IDS - not necessary, project ids, that you need to monitor.
    You are can find project ids using next command: php artisan look:projects.
  • APP_URL
  • DB_DATABASE
  • DB_USERNAME
  • GITLAB_HOST
  • APP_LOCALE - supported locales: en, ru.
  • APP_DATEPICKER_DATE_FORMAT - default is DD.MM.YYYY.

Run migrations:

php artisan migrate

Fill dictionaries:

php artisan db:seed

Create user (with Admin role):

php artisan make:user

Build static:

npm install
npm run prod

Usage

Run next command for import projects, issues and comments from Gitlab:

php artisan import:all

You can run it in schedule (every hour by defaults): php artisan schedule:run.

Now you can build report about spent time using command

php artisan stat:spent-time --start=2018-05-01 --finish=2018-06-01

Filter:

  • start - start date,
  • finish - finish date,
  • user-id - by assignee,
  • project-id - by project,
  • issue-id - by issue,
  • order - for example: issue.iid, project.path_with_namespace

Result:

+---------------------+-------------------+--------------+-------+----------------------------------+
| gitlab_created_at   | project           | issue        | hours | description                      |
+---------------------+-------------------+--------------+-------+----------------------------------+
| 2018-05-18 12:23:56 | my-group/project1 | #5 My time   | 1.00  | Some work                        |
| 2018-05-18 12:24:56 | my-group/project1 | #5 My time   | 0.50  | Export data into pdf             |
| 2018-05-19 20:19:49 | my-group/project1 | #5 My time   | 1.00  | Create templates                 |
| 2018-05-19 21:56:30 | my-group/project1 | #5 My time   | 0.50  | Reading requirements             |
| 2018-05-18 12:23:56 | my-group/project2 | #152 My time | 1.00  | Skype call                       |
| 2018-05-18 12:24:56 | my-group/project2 | #152 My time | 0.50  | Discussion about export into xml |
+---------------------+-------------------+--------------+-------+----------------------------------+

How to upgrade to new version

Using Docker

Just rebuild container

git pull
export host="https://gitlab.com/" \
    && export token="your_gitlab_private_token" \
    && export projects="project_id1,project_id2" \
    && docker-compose up --build app

Without docker

Update code and build static:

git pull
composer install
npm install
npm run prod

Run new migrations:

php artisan migrate

Fill new dictionaries:

sudo php artisan cache:clear
php artisan db:seed
sudo php artisan cache:clear

gitpab's People

Contributors

cebe avatar mnvx avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.