An open API service indexing awesome lists of open source software.

https://github.com/rapideinternet/exposia-bakkuclient

BakkClient is a Laravel client for Bakku CMS. 😎
https://github.com/rapideinternet/exposia-bakkuclient

bakku blade cms html laravel

Last synced: 2 months ago
JSON representation

BakkClient is a Laravel client for Bakku CMS. 😎

Awesome Lists containing this project

README

          


Bakku Logo

## About BakkuClient
BakkuClient is a simple client for the Bakku API. Easily create a website with the Bakku API.


## Features
- [x] Pages
- [x] Components
- [x] Forms
- [x] Caching
- [x] Error handling
- [x] Fully customizable


## Usage
First register your website on Bakku. Then generate a api_key for your website.

#### 1. Fill in the BAKKU_SITE_ID and BAKKU_API_KEY in the .env file
```bash
BAKKU_SITE_ID={{YOUR_SITE_ID}}
BAKKU_API_KEY={{YOUR_API_KEY}}
```

#### 2. Create or edit the pages in /resources/views/pages/

#### 3. To include images use the following code
```html

```

#### 4. To include a collection use the following code
```html

```

#### 5. To change the collections open the /app/View/Components/Collections.php file and change the collections

#### 6.To include the menu use the following code
```html

```

#### 7. Create or edit the components in /resources/views/components/, if you need an extra component use
```bash
php artisan make:component {{ComponentName}}
```

#### 8. To create blocks use the following command
````bash
php artisan make:view blocks/{{BlockName}}
````

#### 9. To include a block use the following code
```php
@foreach($blocks as $block)
@include('blocks.'.$block['label'], ['block' => $block])
@endforeach
```

#### 10. To create a page use the following command
```bash
php artisan make:view pages/{{PageName}}
```


## Installation

#### 1. Fork the repository

#### 2. Clone the repository
```bash
git clone https://github.com/rapideinternet/{{REPO_NAME}}.git
```

#### 3. Go to the project directory
```bash
cd {{REPO_NAME}}
```

#### 4. Install composer dependencies
```bash
composer install
```

#### 5. Copy the .env.example file and rename it to .env
```bash
cp .env.example .env
```

#### 6. Generate a new application key
```bash
php artisan key:generate
```

#### 7. Run the migrations
```bash
php artisan migrate
```

#### 8. Install npm dependencies
```bash
npm install
```

#### 9. Compile the assets
```bash
npm run build
```

#### 10. Run the application
```bash
php artisan serve
```


## License
This client is made by Exposia and is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).