Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
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
- Host: GitHub
- URL: https://github.com/ayine-nongre/access-key-manager
- Owner: Ayine-nongre
- Created: 2024-04-23T19:30:01.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-05-16T13:15:15.000Z (6 months ago)
- Last Synced: 2024-06-09T16:26:26.129Z (5 months ago)
- Topics: express, mongodb, nodejs, nodemailer
- Language: JavaScript
- Homepage:
- Size: 173 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
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 uiLive 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)