README

POS adalah sebuah Application Programming Interfaces (APIs) backend berbasis MVC yang didesain secara terstruktur. Aplikasi ini dikembangkan untuk mejembatani integrasi antara aplikasi dan layanan manajemen penjualan toko.

Cara Pemakaian

Sebelum memulai menggunakan POS, clone source code ke folder, lalu dilanjutkan dengan menginstall dependensi package yang diperlukan.

$ cd dir
$ git clone https://github.com/irvanherz/pos.git
$ yarn add express body-parser mysql multer dotenv jsonwebtoken cors morgan nodemon

POS menggunakan MySQL untuk dapat berjalan. Sehingga pastikan sebelum menjalankan aplikasi POS, MySQL sudah terinstal dan berjalan layanannya. Jangan lupa juga untuk mengubah konfigurasi database dari file .env yang bisa ditemukan di folder root.

Setelahnya POS dapat segera dijalankan dengan yarn.

$ yarn start

Struktur Folder

Direktori :

/src/routes/: berisi kode untuk menangani routing berdasarkan url dan request.
/src/controller/: berisi kode controller yang menjadi jembatan antara request dan model.
/src/model: berisi kode untuk abstraksi akses database
/src/middleware/: berisi kode middleware, kebanyakan untuk filtering dan validasi.
/src/helper/: berisi kode helper untuk membantu jalannya aplikasi.

Dokumentasi API

Manajemen User

Sign up

Mendaftarkan user baru
URL : /auth/signup
Method : POST
Auth required : NO
Permissions required : None

Success Response Code : 200 OK

Sample Request

{
    "name": "John Doe",
    "username": "john_doe",
    "password": "abcde12345",
    "role": "0",
    "status": "0"
}

Output

{
    "status": 200,
    "data": {
        "id": 1,
        "name": "John Doe",
        "username": "john_doe",
        "role": "0",
        "status": "0"
    }
}

Sign in

Login dengan username dan password untuk memperoleh token JWT.
URL : /auth/sigin
Method : POST
Auth required : NO
Permissions required : None

Success Response Code : 200 OK

Sample Request

{
    "username": "john_doe",
    "password": "abcde12345"
}

Output

{
    "status": 200,
    "data": {
        "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MSwibmFtZSI6IkpvaG4gRG9lIiwidXNlcm5hbWUiOiJqb2huX2RvZSIsInJvbGUiOjAsImlhdCI6MTU3OTcxNTAyNCwiZXhwIjoxNTgwMzE5ODI0fQ.LNXpETn_1zDV_UaaMzS63N43M6OWRM0BqKycYq86Z_Q"
    }
}

Manajemen Produk

Tambah Produk

Menambah sebuah produk ke dalam database
URL : /products/
Method : POST
Auth required : YES
Permissions required : YES

Success Response Code : 200 OK

Sample Request

{
    "name": "Nasi Bakar",
    "description": "Cita rasa gurih menggoda tiada tara",
    "category_id": "1",
    "price": "10000"
}

Output

{
    "status": 200,
    "data": {
        "id": 1,
        "name": "Nasi Bakar",
        "description": "Cita rasa gurih menggoda tiada tara",
        "category_id": "1",
        "price": "10000"
    }
}

Ubah Produk

Mengubah sebuah produk yang sudah ada di dalam database. Format input dan output sama seperti saat menambah produk.
URL : /products/:id
Method : PUT
Auth required : YES
Permissions required : YES

Hapus Produk

Menghapus sebuah produk dari database
URL : /products/:id
Method : DELETE
Auth required : YES
Permissions required : YES

Success Response Code : 200 OK

Sample Output

{
    "status": 200,
    "data": {
        "id": "2",
        "message": "Delete OK"
    }
}

Tampilkan Sebuah Produk

Mengambil data sebuah produk berdasarkan parameter ID nya.
URL : /products/:id
Method : GET
Auth required : YES
Permissions required : YES

Success Response Code : 200 OK

Sample Output

{
    "status": 200,
    "data": {
        "id": 3,
        "name": "Nasi Goreng",
        "description": "Dibuat dengan sepenuh cinta demi rasa enak tak terlupakan",
        "category": null,
        "image": null,
        "price": 10000,
        "created_at": "2020-01-22T18:03:28.000Z",
        "updated_at": "2020-01-22T18:03:28.000Z"
    }
}

Tampilkan Daftar Produk

Mengambil data deretan produk dari urutan paling baru.
URL : /products/
Method : GET
Auth required : YES
Permissions required : YES

Success Response Code : 200 OK

Sample Output

{
    "status": 200,
    "data": [
        {
            "id": 3,
            "name": "Nasi Goreng",
            "description": "Dibuat dengan sepenuh cinta demi rasa enak tak terlupakan",
            "category": null,
            "image": null,
            "price": 10000,
            "created_at": "2020-01-22T18:03:28.000Z",
            "updated_at": "2020-01-22T18:03:28.000Z"
        },
        {
            ...
        }
    ]
}

Manajemen Kategori

Tambah Kategori

Menambah kategori produk baru ke dalam database
URL : /categories/
Method : POST
Auth required : YES
Permissions required : YES

Success Response Code : 200 OK

Sample Request

{
    "name": "Drinks"
}

Output

{
    "status": 200,
    "data": {
        "id": 1,
        "name": "Drinks"
    }
}

Ubah Kategori

Mengubah sebuah kategori yang sudah ada di dalam database. Format input dan output sama seperti saat menambah kategori.
URL : /categories/:id
Method : PUT
Auth required : YES
Permissions required : YES

Hapus Kategori

Menghapus sebuah kategori dari database
URL : /categories/:id
Method : DELETE
Auth required : YES
Permissions required : YES

Success Response Code : 200 OK

Sample Output

{
    "status": 200,
    "data": {
        "id": "2",
        "message": "Delete OK"
    }
}

Tampilkan Sebuah Kategori

Mengambil data sebuah produk berdasarkan parameter ID nya.
URL : /categories/:id
Method : GET
Auth required : YES
Permissions required : YES

Success Response Code : 200 OK

Sample Output

{
    "status": 200,
    "data": {
        "id": 2,
        "name": "Foods",
        "created_at": "2020-01-22T18:15:03.000Z",
        "updated_at": "2020-01-22T18:15:03.000Z"
    }
}

Tampilkan Daftar Kategori

Mengambil data deretan kategori dari dalam database.
URL : /categories/
Method : GET
Auth required : YES
Permissions required : YES

Success Response Code : 200 OK

Sample Output

{
    "status": 200,
    "data": [
        {
            "id": 1,
            "name": "Drinks",
            "created_at": "2020-01-22T18:12:07.000Z",
            "updated_at": "2020-01-22T18:12:07.000Z"
        },
        {
            ...
        }
    ]
}

Manajemen Order

Tambah Order

Menambah produk-produk sebagai sebuah order baru.
URL : /orders/
Method : POST
Auth required : YES
Permissions required : YES

Success Response Code : 200 OK

Sample Request

{
    "orderItems": [
        {
            "product_id": 1,
            "qty": 3
        },
        {
            "product_id": 3,
            "qty": "1"
        }
    ]
}

Output

{
    "status": 200,
    "data": {
        "id": 1,
        "cashier_id": 2,
        "invoice_id": 7734562,
        "price": 44000,
        "orderItems": [
            {
                "id": 1,
                "order_id": 7734562,
                "product_id": 1,
                "qty": 3,
                "price": 30000,
                "product": {
                    "id": 1,
                    "name": "Nasi Bakar",
                    "description": "Cita rasa gurih menggoda tiada tara",
                    "category": "Drinks",
                    "image": null,
                    "price": 10000,
                    "created_at": "2020-01-22T17:49:12.000Z",
                    "updated_at": "2020-01-22T17:49:12.000Z"
                }
            },
            {
                ...
            }
        ]
    }
}

Hapus Order

Menghapus order dari database
URL : /orders/:id
Method : DELETE
Auth required : YES
Permissions required : YES

Success Response Code : 200 OK

Sample Output

{
    "status": 200,
    "data": {
        "id": "2",
        "message": "Delete OK"
    }
}

Tampilkan Sebuah Order

Mengambil data sebuah produk berdasarkan parameter ID nya.
URL : /orders/:id
Method : GET
Auth required : YES
Permissions required : YES

Success Response Code : 200 OK

Sample Output

{
    "status": 200,
    "data": {
        "id": 1,
        "cashier_id": 2,
        "invoice_id": 7734562,
        "created_at": "2020-01-22T18:32:32.000Z",
        "updated_at": "2020-01-22T18:32:32.000Z",
        "price": 44000,
        "orderItems": [
            {
                "id": 1,
                "order_id": 7734562,
                "product_id": 1,
                "qty": 3,
                "created_at": "2020-01-22T18:32:32.000Z",
                "updated_at": "2020-01-22T18:32:32.000Z",
                "price": 30000
            },
            {
                ...
            }
        ]
    }
}

Tampilkan Daftar Order

Mengambil data deretan order dari dalam database. Output hampir sama seperti saat menampilkan sebuah order saja. Namun, di sini kita akan memperoleh order dalam bentuk array.
URL : /orders/
Method : GET
Auth required : YES
Permissions required : YES

Success Response Code : 200 OK

Sample Output

{
    "status": 200,
    "data": [
        {
            "id": 1,
            "name": "Drinks",
            "created_at": "2020-01-22T18:12:07.000Z",
            "updated_at": "2020-01-22T18:12:07.000Z"
        },
        {
            ...
        }
    ]
}

irvanherz / pos Goto Github PK

pos's Introduction

README

Cara Pemakaian

Struktur Folder

Dokumentasi API

Manajemen User

Sign up

Sign in

Manajemen Produk

Tambah Produk

Ubah Produk

Hapus Produk

Tampilkan Sebuah Produk

Tampilkan Daftar Produk

Manajemen Kategori

Tambah Kategori

Ubah Kategori

Hapus Kategori

Tampilkan Sebuah Kategori

Tampilkan Daftar Kategori

Manajemen Order

Tambah Order

Hapus Order

Tampilkan Sebuah Order

Tampilkan Daftar Order

pos's People

Contributors

Stargazers

Watchers

Forkers

pos's Issues

Recommend Projects

Recommend Topics

Recommend Org