walnut07 / Kanjify

Want to know how to spell your name in kanji? Kanjify is here for you to give you a kanjified name.

Home Page:https://kanjify.herokuapp.com

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Kanjify

About the project

screenshot of Kanjify

Want to know how to spell your name in kanji? Kanjify is here for you to give you a kanjified name.

Try it out here: https://kanjify.herokuapp.com

Developers

Built with

picture of a list of our tech stack

Getting Started

Once forking this repository and cloning it to your computer, install libraries.

  • npm

In Kanjify/server and Kanjify/client, run

$ npm install
  • Express / Knex.js / Wanakana

In Kanjify/server, run

$ npm install express knex wanakana

Then, set up your local database. Create a local Postgres database called 'kanjify'.

CREATE DATABASE kanjify;

In server/db, run

$ knex migrate:latest

Create .env.local file in server/db. Write information below.

DB_USER=YOUR PSQL USERNAME
DB_PASSWORD=YOUR PSQL PASSWORD
DB_NAME=kanjify

After installing those libraries, you should be able to run the app. In Kanjify/client and In Kanjify/server, run

$ npm start

Logic behind the scenes

This map shows how frontend and backend communicate each other. It is not 100% accurate but was made for improving developers' understanding. Map describing the kanjifying process

Want to know more about Kanjify?

Please take a look at this slide if you want to know the persona, future features, or engineering challenges. https://docs.google.com/presentation/d/1T_csjN-K_JbxuHWR56iCB8ss_XQbSkXD7xOw_WlVTF4/edit?usp=sharing

About

Want to know how to spell your name in kanji? Kanjify is here for you to give you a kanjified name.

https://kanjify.herokuapp.com


Languages

Language:JavaScript 73.4%Language:CSS 19.4%Language:HTML 7.0%Language:Procfile 0.2%