https://github.com/sukso96100/authbook

Self hosted OTP Webapp
https://github.com/sukso96100/authbook

exposed javascript kotlin ktor mdc-react mysql otp reactjs

Last synced: 3 months ago
JSON representation

Self hosted OTP Webapp

• Host: GitHub
• URL: https://github.com/sukso96100/authbook
• Owner: sukso96100
• License: gpl-3.0
• Created: 2018-12-31T10:44:01.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2023-01-07T03:01:28.000Z (almost 2 years ago)
• Last Synced: 2024-10-02T09:28:28.371Z (3 months ago)
• Topics: exposed, javascript, kotlin, ktor, mdc-react, mysql, otp, reactjs
• Language: JavaScript
• Size: 5.02 MB
• Stars: 8
• Watchers: 5
• Forks: 2
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • License: COPYING.txt

Awesome Lists containing this project

README

        
![Icon](frontend/public/icons/icon-72x72.png)

# Authbook

![App Preview](login.png)

![App Preview](home.png)

![App Preview](menu.png)

![App Preview](settings.png)

Authbook is a self-hosted OTP Web app software.  

The backend is built with Kotlin, Ktor and Exposed framework and the frontend is built with Javascipt, React and MDC(Material Design Components)

This project is in development stage and it isn't fullly functional yet.

- [Live demo](https://authbook.youngbin.xyz)

- [Demo video(YouTube)](https://youtu.be/AlQjdASa2EQ)

## To Do

- [x] Signup(with email verification)

- [x] Password recovery

- [x] Login

- [x] Add/Remove OTP Seed

- [x] Show list of OTP Seeds

- [x] Edit OTP Seed

- [ ] Store Seed data offline

- [ ] Localization

- [ ] Session manager

- [x] Deploy manual

- [x] Themeing

- [ ] Enable PWA

## Deploy

### Frontend

Start test server

```bash

cd frontend

npm install

npm start

```

Generate production build

```bash

cd frontend

npm install

npm build

```

### Backend

- Prepare Java and Mysql server instance

- Edit `backend/resources/application.conf` or setup environment variables(see `application.conf` for required environment variables)

Run server instantly

```

./gradlew :run

```

Build docker image(See [here](https://github.com/GoogleContainerTools/jib/tree/master/jib-gradle-plugin) for more detailed guides)

```

./gradlew jib

```

 

## Author

Youngbin Han([email protected])

## License

GNU General Public License v3.0

See [COPYING.txt](COPYING.txt) to see the full text.