📘 A simple Kanban-like word book
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
client
config
docs
server
test
.babelrc
.eslintrc.json
.gitignore
.travis.yml
LICENSE
Procfile
README.md
app.json
package.json

README.md

Word Kanban

A simple Kanban-like word book, which is entirely written with Node. The user system is powered by Auth0. All the icons are actually emojis.

And we use Preact stacks for client side.

For demo use, please visit here https://word-kanban.herokuapp.com/.

Development

Clone & Init

$ git clone https://github.com/crispgm/word-kanban.git
$ yarn install

Migrate

$ node_modules/.bin/sequelize db:migrate

Build

$ yarn dev-build

Run

$ GOOGLE_TRANSLATE_API_KEY=your-google-api-key yarn start

Note: You may run without a GOOGLE_TRANSLATE_API_KEY. However, the hover translation will definitely not work.

Deploy with Heroku

Deploy

Create app

$ heroku create your-app-name
$ heroku git:remote -a your-app-name

Set config vars

$ heroku config:set NPM_CONFIG_PRODUCTION=false
$ heroku config:set GOOGLE_TRANSLATE_API_KEY=your-google-api-key
$ heroku config:set TOKEN_PRIVATE_KEY=your-private-token

Create DB

$ heroku addons:add heroku-postgresql:dev
$ heroku config:set DATABASE_URL=your-database-url

Migrate

$ heroku run bash
$ cd server
$ sequelize db:migrate

License

MIT License.

Copyright (c) 2018 David Zhang.