Git Product home page Git Product logo

shoes's Introduction

katalyst

KKday Translation System

Setup

Prerequisites

  • PHP >= 7.1.3
  • Laravel >= 5.8
  • Redis >= 4.0.1
  • PostgreSQL >= 11.3
  • npm >= 6.7.0

Installations

$ git clone [email protected]:kkday-it/katalyst.git
# clone codebase

$ php composer.phar install
# install composer packages

PostgreSQL

$ brew install postgresql
# install postgresql

$ brew services start postgresql
# start postgresql

$ createuser developer
# create an user for postgresql

$ createdb translationdb
# create database

$ psql -h localhost translationdb -U developer
# connect to localhost translationdb using developer

$ translationdb=> grant all privileges on database translationdb to developer;
# grant privileges for user

Redis

$ brew install redis
# install redis

$ redis-server
# start redis server

Post-Installation

$ cp .env.example .env
# create your own local .env

$ php artisan key:generate
# generate application key

$ php artisan migrate
# generate table schema for develop

$ php artisan db:seed
# generate database seed data for develop

Start Service

$ php artisan serve
# Laravel development server started: <http://127.0.0.1:8000>

Frontend Setup

base on ant-design-vue

Project setup

$ cd frontend
# change directory to frontend folder

$ npm install

Compiles and hot-reloads for development

$ cp .env.example .env
# create your .env if neccessary

$ npm run serve

Compiles and minifies for production

$ npm run build

Lints and fixes files

$ npm run lint

Customize configuration

See Configuration Reference.

API Document

Swagger UI

Displays API documents according to swagger.yaml, refernce Swagger UI Github for running Swagger UI in your local machine.

$ docker pull swaggerapi/swagger-ui
# pulls the swagger-ui docker image

$ cd $PROJECT_PATH;
# go to project path

$ docker run -p 8888:8080 -e SWAGGER_JSON=/documents/swagger.yaml -v $PWD/documents:/documents swaggerapi/swagger-ui

$ visit http://127.0.0.1:8888/

shoes's People

Contributors

vophamtandoan99 avatar

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.