Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/ayine-nongre/access-key-manager

An access manager for a multitenant school management software
https://github.com/ayine-nongre/access-key-manager

express mongodb nodejs nodemailer

Last synced: 1 day ago
JSON representation

An access manager for a multitenant school management software

Awesome Lists containing this project

README

        

# Access Key Manager
This repo contains an access key manager for a multitenant school management software, this project was built with NodeJS, express, mongodb.
## Documentation
Click on [docs](https://micro-accessmanager.onrender.com/api-docs/) for api documentation using swagger ui

Live url - https://micro-accessmanager.onrender.com/api-docs/

## Features Implemented
Admin:
1. Login with email and password.
2. Revoke a user password.
3. See all keys generated on the platform (active, expired, revoked).
4. Retrieve a school's active access key using school email.

IT personnel:
1. Signup and login using email and password.
2. Verify account after signing up.
3. Reset account password.
4. Generate new active key if no active key is available.
5. See all keys granted to user on the platform (active, expired, revoked).
6. See details of each key (status, date of procurement, expiry date).
## GETTING STARTED
1. Clone the project

```
git clone https://github.com/Ayine-nongre/Access-key-manager.git
```
2. Change to project directory

```
cd Access-key-manager/
```
3. Set up enviroment variables in env file
4. Install packages used in project

```
npm install
```
5. Start server

```
nodemon app.js
```

## ER Diagram
![ER diagram](https://github.com/Ayine-nongre/Access-key-manager/blob/main/ER%20Diagram.drawio.png)