adipginting / industrialisasi-api

API for Industrialisasi.

Home Page:https://api.industrialisasi.com/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Industrialisasi API

This repository contains the API end points used by Industrialisasi UI. The API is developed in JavaScript on top of ExpressJS and NodeJS. This software comes at no guarantee and support. Use at your own risk.

Requirements

  1. You need to have Postgres 14 and Node.js 16 installed on your computer. The operating system is preferably Ubuntu.
  2. Create the required tables and database. The example scripts are create-db.sh, create-table.sh, and init.sql on the root directory of this project.

How to run this repository?

git clone https://github.com/adipginting/industrialisasi-api
cd industrialisasi-api
npm install
npm start

Run via docker

git clone https://github.com/adipginting/industrialisasi-api
cd industrialisasi-api
sudo docker run -p 4000:4000 -d

Run via docker compose

Alternatively, I created a repository to run the whole website i.e. database server, api server, and the interface server with Docker Compose (a work on progress). See: https://github.com/adipginting/industrialisasi.

To do and progress:

  • Register api end point.
  • Login api end point.
  • An api end point to check email existence on database.
  • An api end point to check username existence on database.
  • Use session cookie.
  • An api end point to send validation email to users.
  • Session cookie generation on login.
  • An api end point to save post.
  • An api end point to retrieve post.
  • An api end point to save comment.
  • An api end point to retrieve comment.
  • Better security.
  • Create API documentation using OpenAPI specification.

About

API for Industrialisasi.

https://api.industrialisasi.com/

License:MIT License


Languages

Language:JavaScript 97.4%Language:Shell 1.8%Language:Dockerfile 0.8%