Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/crispgm/word-kanban

:blue_book: A simple Kanban-like word book
https://github.com/crispgm/word-kanban

auth0 auth0-jwt kanban nodejs preact

Last synced: about 1 month ago
JSON representation

:blue_book: A simple Kanban-like word book

Host: GitHub
URL: https://github.com/crispgm/word-kanban
Owner: crispgm
License: mit
Created: 2018-01-14T04:10:14.000Z (almost 7 years ago)
Default Branch: master
Last Pushed: 2020-06-28T07:03:46.000Z (over 4 years ago)
Last Synced: 2024-10-01T06:40:59.236Z (about 1 month ago)
Topics: auth0, auth0-jwt, kanban, nodejs, preact
Language: JavaScript
Homepage: https://word-kanban.herokuapp.com/
Size: 392 KB
Stars: 1
Watchers: 3
Forks: 2
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# [Word Kanban](https://word-kanban.herokuapp.com/)

[![travis](https://api.travis-ci.org/crispgm/word-kanban.svg?branch=master)](https://travis-ci.org/crispgm/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 .

## Development

Clone & Init

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

Migrate

```shell
$ node_modules/.bin/sequelize db:migrate
```

Build

```shell
$ yarn dev-build
```

Run

```shell
$ 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](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/crispgm/word-kanban)

Create app

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

Set config vars

```shell
$ 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

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

Migrate

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

## License

MIT License.