https://github.com/souvik666/ghost-auth
Rapidly integrate authentication and authorization for web, mobile, and legacy applications so you can focus on your core business. grab your api key from here https://ghost-auth.netlify.app/
https://github.com/souvik666/ghost-auth
api authentication authorization express sdk-nodejs
Last synced: 18 days ago
JSON representation
Rapidly integrate authentication and authorization for web, mobile, and legacy applications so you can focus on your core business. grab your api key from here https://ghost-auth.netlify.app/
- Host: GitHub
- URL: https://github.com/souvik666/ghost-auth
- Owner: souvik666
- Created: 2022-05-06T18:16:18.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-05-10T14:33:32.000Z (over 3 years ago)
- Last Synced: 2025-08-09T07:02:24.219Z (6 months ago)
- Topics: api, authentication, authorization, express, sdk-nodejs
- Language: JavaScript
- Homepage: https://ghost-auth-service.herokuapp.com/
- Size: 30.3 KB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Welcome to ghost-auth 👋
> Rapidly integrate authentication and authorization for web, mobile, and legacy applications so you can focus on your core business.
# Quick links
- **[Get Free API key](https://ghost-auth.netlify.app/)**
- **[API Documentation](https://ghost-auth-service.herokuapp.com/)**
- **[Ghost auth npm package](https://www.npmjs.com/package/ghost-auth)**
# API Documentation
you can find the API documentation here [LINK](https://ghost-auth-service.herokuapp.com/)
to use the api or the npm package you will need an API-KEY please get your API key from this website [LINK](https://ghost-auth.netlify.app/)
## FLOW
```mermaid
graph LR
A[GO to the website] -- Grab your api key --> B(Click on authorized buttton and past the api-key)
B <--> D{test the api}
```
# ghost-auth Documentation
## Install
```sh
npm i ghost-auth
```
## Import
```js
import GhostAuth from "ghost-auth";
```
## Instance
```js
const API_KEY = "YOUR_API_KEY";
const ghost = new GhostAuth(API_KEY);
```
## signUp
```js
ghost
.signUp({
email: "souvik@gmail.com",
password: "souvik@12345",
name: "souvik",
})
.then((d) => {
console.log(d);
});
```
## Login
```js
ghost.Login({ email: "souvik@gmail.com", password: "souvik@12345" });
```
## Logout
```js
ghost.Logout().then((d) => {
console.log(d);
});
```
## IsAuth
```js
ghost.isAuth().then((d) => {
console.log(d);
});
```
## Forgotpass
```js
ghost.Forgotpass(email).then((d) => {
console.log(d);
});
```
## ResetPassword
```js
ghost.ResetPassword(otp, password, token).then((d) => {
console.log(d);
});
```
## Get All users
```js
ghost.GetAllUsers().then((d) => {
console.log(d);
});
```
## Delete A User
```js
ghost.DeleteAUser("someactualemail@email.com").then((d) => {
console.log(d);
});
```
## Author
👤 **souvik666**
- Github: [@souvik666](https://github.com/souvik666)
## Show your support
Give a ⭐️ if this project helped you!
---
_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_