Giter VIP home page Giter VIP logo

jibikiapi's Introduction

Jibiki CircleCI

Branding icon

Jibiki

Jibiki is a fast and reliable open-source dictionary website and app, this repository contains the API which is responsible for all functionality. The front-end repository can be found at JibikiFrontend.

A Java and Kotlin library to interact with the API can be found at Jibiki Java Client

Goals

  • Build a comprehensive completely free API tailored to the needs of language learners and developers
  • Create an environment in which you can easily; bookmark words, save them to your own deck, learn and review words in a single click.
  • Assist in the understanding of complicated sentences by providing a tool that will break down your sentence in a click and display information about every segment.

Development environment set-up

Windows

On Windows, you will need to install Windows Subsystems for Linux (WSL) in order to run the PostgreSQL database Jibiki requires.

  1. Enable WSL by going to the Turn windows features on and off settings tab
  2. Go to the Microsoft Store and install Ubuntu 18.06 or any distrobution of your choosing
  3. Start Ubuntu and create a new username and password
  4. Run apt update && apt upgrade -y
  5. Run apt install build-essential -y
  6. Resume by following the database setup instructions below

Database setup

  1. Install PostgreSQL by running apt install postgresql
  2. Create a database called jibiki by entering the PSQL shell utility with psql -U postgres and then running CREATE DATABASE jibiki; then exit using \q
  3. Clone JMdictDB by running git clone https://gitlab.com/yamagoya/jmdictdb/
  4. cd into the JMDictDB directory
  5. Run make install
  6. Download and install TatoebaPostgreSQL, see the README for install instructions.
  7. Download and install Kanjidic2Importer, see the README for install instructions.

Environment setup

  1. Clone the JibikiFrontend repository and follow the setup instructions in the README
  2. Clone this repository
  3. Run JibikiFrontend and JibikiAPI at the same time, the frontend can then be found at localhost and the API will run at localhost:8080

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.