README

Simple PHP Forum system for developers.

Installation

Via Composer

composer create-project asika/natika natika *

cd natika/

After composer installed, Natika will help you set some basic settings to enable site and create admin user.

Via Git

If you want to use git to keep Natika update to newest version, you can use git to install Natika.

git clone git@github.com:asika32764/natika.git

cd natika/

composer install

Then copy etc/secret.dist.yml to etc/secret.yml and open it to fill database account.

Other Commands

If you want to test with fake data, you can add seeders by

php natika migration reset --seed

Create a new admin user

php natika create-user

Getting Started

Use your root user to login Natika. You can create category by click New Category button.

Fill category information, icon uses Font Awesome classes.

If you want to use image as category icon, you must go to admin.

Create & edit topics.

Admin

Go to http://{your.site}/admin, and login with admin account.

Category Edit

Article Edit

Article will display on frontend top menu. If you fill the URL input, menu item will be an external link.

You can drag & drop images to upload.

Config

Open etc/secret.yml, there are some basic settings which you can change.

Site Metadata

natika:
    site_name: Natika
    metadata:
        description:
        'og:description':
        'og:image':
    banner:
        default: # Banner title
    theme: # Your custom theme

Mail Settings

mail:
    from:
        email: norply@domain.com
        name: Natika Forum
    transport: smtp # smtp / sendmail or php
    
    # SMTP setting
    host: mailtrap.io
    username:
    password:
    security: tls
    port: 2525

Cloud Image Storage

unidev:
    image:
        storage: s3 # s3 or imgur
        
        # Auto resize image
        resize:
            enabled: true
            width: 1200
            height: 1200
            crop: false
            quality: 85
            
    # API information
    amazon:
        key:
        secret:
        bucket:
        subfolder:
        endpoint: # Keep empty
        region: # Keep empty
    imgur:
        key:
        secret:

Customize Theme

See Customize Document

Social Login

See Social Login Document

Hide Source Files

If you want to create a /public folder to hide all source files. See Hide Source Files

Development

Natika based on these packages:

Natika provides package and event system to help develops create their plugins, but we need more test to release this feature, so there are no documentation about plugins currently, please wait for future inforamtion.

asika / natika

Maintainers

Details