Skip to content

Latest commit

 

History

History
212 lines (161 loc) · 7.07 KB

CONTRIBUTING.md

File metadata and controls

212 lines (161 loc) · 7.07 KB

Contribute to badaso

Badaso is an open-source project administered by uasoft. We appreciate your interest and efforts to contribute to Badaso.

All efforts to contribute are highly appreciated, we recommend you talk to a maintainer prior to spending a lot of time making a pull request that may not align with the project roadmap.

Open Development & Community Driven

Badaso is an open-source project. See the license file for licensing information. All the work done is available on GitHub.

The core team and the contributors send pull requests which go through the same validation process.

Feature Requests

Feature Requests by the community are highly encouraged. Please feel free to submit your ides on github discussion

Code of Conduct

This project and everyone participating in it are governed by the Badaso Code of Conduct. By participating, you are expected to uphold this code. Please read the full text so that you can read which actions may or may not be tolerated.

Bugs

We are using GitHub Issues to manage our public bugs. We keep a close eye on this so before filing a new issue, try to make sure the problem does not already exist.

Before Submitting a Pull Request

The core team will review your pull request and will either merge it, request changes to it, or close it.

Before submitting your pull request make sure the following requirements are fulfilled:

To do : complete this section

Contribution Prerequisites

  • You are familiar with Git.

Development Workflow

Before develop Badaso, please get BADASO_LICENSE_KEY by register on Badaso or contact badaso core team. This key must be included in the laravel project's .env. Steps for registering and getting a license on Badaso Dashboard can be found on Badaso Docs.

Installation step

After getting the license, you can proceed to Badaso installation.

1, Clone badaso into Laravel project. Sample:

  • Root Laravel Project
    • /packages // new folder
      • /badaso // new folder
        • core // clone here

cd into badaso directory, then run

git clone https://github.com/uasoft-indonesia/badaso.git
  1. Add the following Badaso provider and JWT provider to /config/app.php.
'providers' => [
  ...,
  Uasoft\Badaso\Providers\BadasoServiceProvider::class,
  Tymon\JWTAuth\Providers\LaravelServiceProvider::class,
]
  1. Add the following aliases to config/app.php.
'aliases' => [
    ...,
    'JWTAuth' => Tymon\JWTAuth\Facades\JWTAuth::class,
    'JWTFactory' => Tymon\JWTAuth\Facades\JWTFactory::class,
]
  1. Add badaso providers to autoload
"autoload": {
    "psr-4": {
        "App\\": "app/",
        "Uasoft\\Badaso\\": "packages/uasoft-indonesia/badaso/src/"
    },
    ...
}

  1. Copy required library from packages/badaso/core/composer.json to /composer.json then composer install

  2. Run the following commands to update dependencies in package.json and webpack.

php artisan badaso:setup
  1. Run the following commands in sequence.
composer dump-autoload
php artisan migrate
php artisan db:seed --class=BadasoSeeder
  1. Open the env file then add the following lines.
#Set a key as secret key for generating JWT token
JWT_SECRET=

#Set JWT Token lifetime, default 60 minutes
BADASO_AUTH_TOKEN_LIFETIME=

#License key (get the license on https://badaso.uatech.co.id)
BADASO_LICENSE_KEY=

#Set default menu to generate menu in dashboard. 
#By default Badaso provide `admin` as default menu
MIX_DEFAULT_MENU=admin

#Set Route prefix for your dashboard. 
#Access dashboard via {HOST}/{MIX_ADMIN_PANEL_ROUTE_PREFIX}
MIX_ADMIN_PANEL_ROUTE_PREFIX=dashboard

#Set prefix for api that badaso provide. By default 
#Badaso provide `badaso-api` as prefix. 
MIX_API_ROUTE_PREFIX=admin

#Badaso provide Log Viewer feature. please set a route to access this feature
MIX_LOG_VIEWER_ROUTE="log-viewer"

:::important MIX_ADMIN_PANEL_ROUTE_PREFIX, MIX_API_ROUTE_PREFIX & MIX_LOG_VIEWER_ROUTE should be different :::

  1. Add the following Badaso guard and auth provider in config/auth.php. Make sure to use Badaso guard as auth default in config/auth.php.
return [
  'defaults' => [
    'guard' => 'badaso_guard',
    'passwords' => 'users',
  ],

  'guards' => [
    ...,
    'badaso_guard' => [
        'driver' => 'jwt',
        'provider' => 'badaso_users',
    ],
  ],

  'providers' => [
    ...,
    'badaso_users' => [
        'driver' => 'eloquent',
        'model' => \Uasoft\Badaso\Models\User::class,
    ],
  ],

  ...,
]
  1. Create an admin account by typing the following command.
php artisan badaso:admin [email protected] --create
  1. Run the command npm install to install all of dependencies
  2. Update webpack.mix.js from
// Badaso
mix.js(
        "vendor/badaso/core/src/resources/js/app.js",
        "public/js/badaso.js"
    )

into

// Badaso
mix.js(
        "packages/badaso/core/src/resources/js/app.js",
        "public/js/badaso.js"
    )
  1. Run laravel with the command npm run watch if it is under development environment or npm run prod for production environment.

Running the tests

To do : complete this section

Reporting an issue

Before submitting an issue you need to make sure:

  • You are experiencing a concrete technical issue with Badaso.
  • You have already searched for related issues, and found none open (if you found a related closed issue, please link to it from your post).
  • You are not asking a question about how to use Badaso or about whether or not Badaso has a certain feature. For general help using Badaso, you may:
  • Your issue title is concise, on-topic and polite.
  • You can and do provide steps to reproduce your issue.
  • You have tried all the following (if relevant) and your issue remains:
    • Make sure you have the right application started.
    • Make sure the issue template is respected.
    • Make sure your issue body is readable and well formatted.
    • Make sure the application you are using to reproduce the issue has a clean node_modules or vendor directory, meaning:
      • that you haven't made any inline changes to files in the node_modules or vendor folder
      • that you don't have any weird global dependency loops. The easiest way to double-check any of the above, if you aren't sure, is to run: $ rm -rf node_modules && npm cache clear && npm install.