mhdsyarif / kamus-teknologi

Kamus Teknologi

Kamus Teknologi

Bahasa Indonesia | English

Bahasa Indonesia

Referensi

Kode program bersumber dari: https://github.com/gges5110/React-Semantic-UI-Sortable-Table-Example

Ihwal

Repositori ini menyimpan perkakas yang digunakan untuk membuat Situs Kamus Teknologi

---

English

Information and Credits

This code is custom from this repo https://github.com/gges5110/React-Semantic-UI-Sortable-Table-Example

Prerequisite

Node.js runtime environment of 10.16.0.

Quick Start

# Install dependencies
npm ci

# Start JSON server on port 4000
npm run start:server

# Start client with hot reload on port 3000
npm run start

List All Available Custom Script

npm run

Build Client for Production

To compile the React component in production mode, type

npm run build

Client: Create React App

The React setup is bootstrapped with Create React App. Locally it serves public/index.html, and creates a bundle with src/index.jsx as the entry.

Locally it is running on port 3000, and proxies API calls through localhost:4000.

In production build it creates the bundle along with an injected index.html in build/, and can be served statically.

Server: JSON Server

This project uses JSON server to fulfill the API portion with a single JSON file.

Locally it let Create React App to serve the client, allowing for hot reload to happen.

In production we pick up the static assets built by npm run build, and serve them through the same backend port (4000).

Deployment

I deploy the application with docker, and is configured by now.json

Docker

# Build the image
docker build -t {SOME_TAG} .
# Run the container with exposing port 5000
docker run -p 5000:4000 {SOME_TAG}

Dev Guide

Code Formatting

We use prettier to format our code.

npm run prettier

Server APIs

Operation	HTTP Method	Example	Remarks
Get Dictionary List	Get	/api/v1/dictionaries?q=&_page=0&_limit=10&_order=asc&_sort=package	Available query params: q, _offset, _limit, _order, _sort.
Toggle Favorite	Put	/api/v1/dictionaries/:id	Requires to send the JSON formatted Dictionary in the body.

Sorting data on front-end v.s. back-end

Depending on the data set size and the connectivity, we can sort the Dictionary data either on front-end or the back-end. When the data set size is small it is easier to send the whole data set to the client size and do all the sorting and filtering in the browser. But this will not scale well as the data size grows, especially it could have millons of rows. To limit the data being sent over to the front-end, I only allow 100 records per request.

Input Validation

Each time a character changes in filter input, it will check two things. 1) If the input contains invalid character, and 2) there is no result being found after applying the filter. For the first case, the input UI will turn red and a popup will show a message warning the user. If the filter will cause the result to be empty, the popup will inform the user about this. On the server side, it will also check if the input only contains alphanumerics, and will send a 422 response along with an error message.