https://github.com/tanukihq/genkan
玄関 Genkan｜Seamless authentication system using NodeJS and MongoDB
https://github.com/tanukihq/genkan
authentication genkan login login-system mongodb nodejs
Last synced: 10 months ago
JSON representation
玄関 Genkan｜Seamless authentication system using NodeJS and MongoDB
- Host: GitHub
- URL: https://github.com/tanukihq/genkan
- Owner: TanukiHQ
- License: gpl-3.0
- Created: 2021-03-05T14:52:44.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2022-12-14T01:14:37.000Z (about 3 years ago)
- Last Synced: 2025-04-14T02:11:38.536Z (10 months ago)
- Topics: authentication, genkan, login, login-system, mongodb, nodejs
- Language: JavaScript
- Homepage:
- Size: 1.88 MB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Genkan 玄関
Genkan is a session based authentication system written in NodeJS and uses MongoDB as its database.
> ### ⚠️ Don't implement Genkan in any production environment (just yet!)
> This project is still heavily in development. It is highly and extremely discouraged to use Genkan in any production environment.
## Why use Genkan
Genkan is made to be easily implementable across any Node application regardless of scale. A Node application can simply check for the browser cookie against the session ID stored in MongoDB to check for login state.
## Download
You can download Genkan using the following options:
### NPM
```
npm i genkan
```
**or**
### Git Clone
```
git clone https://github.com/HakkouHQ/Genkan.git
```
## Setup
Install all necessary node modules with the following command.
The default theme for Genkan, [Uchi](https://github.com/TanukiHQ/genkan-theme-uchi), will be installed as well.
```
npm i
```
### Next,
```
node app.js
```
**or**
```
nodemon
```
Running Genkan for the first time will generate a `config.json` file.
Run Genkan again with the following command above and open `http://localhost:5000/login` in your browser.
## License
- [GPL-3.0 License](https://www.gnu.org/licenses/gpl-3.0.en.html)