Data

Tools

Indexes

Applications

Experiments

Awesome

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

https://github.com/juliusmarkwei/access-portal

access key management tool for system administrators
https://github.com/juliusmarkwei/access-portal

access-control api authentication celery python3 redis security-tools

Last synced: about 1 month ago
JSON representation

access key management tool for system administrators

Awesome Lists containing this project

README 

          
# Access Portal Backend build with Django Rest Framework and  Celery





    




## Overview



Access Portal is an Access Key Manager web application developed for Micro-Focus Inc. to manage access keys for their multi-tenant school management platform. Schools can use this application to purchase access keys to activate their accounts. This project involves building a key manager that includes user authentication, key management, and integration capabilities.



## Project Objective



Micro-Focus Inc., a software company, has built a school management platform that is multi-tenant. Various schools can set up on the platform as if it was built specifically for them. They have chosen to use an access key-based approach for monetization rather than integrating payment features directly into the software. This project aims to develop a web application that schools can use to purchase and manage access keys to activate their accounts.



## Major Features 🔑



### School IT Personnel



1. **`Signup & Login`**: School IT personnel is able to sign up and log in with an email and password. Account verification and a reset password feature to recover lost passwords is included.

2. **`Access Key Management`**: Users is able to see a list of all access keys granted: active, expired, or revoked.

3. **`Key Details`**: For each access key, users is able to see the status, date of procurement, and expiry date.

4. **`Key Constraints`**: Users should not be able to obtain a new key if an active key is already assigned. Only one key can be active at a time.



### Micro-Focus Admin



1. **`Admin Login`**: Admins is able to log in with an email and password.

2. **`Manual Key Revocation`**: Admins is able to manually revoke an access key.

3. **`Key Overview`**: Admins is able to see all keys generated on the platform, including their status, date of procurement, and expiry date.

4. **`Active Key LookUp Endpoint`**: Admins is able to access an endpoint that, given a school email, returns the status and details of the active key if any, or a 404 status if no active key is found. This allows integration with the school management software.



## Additions (top-ups)



1. School IT Personnel's key created must be activated by admin. Admins are `notified` via `email` if a key is created.

2. When status of a key changes, School IT Personnels are `alerted` via `email` by a custome mail template.

3. When creating a key, in addition to a `key-tag`, a user must input the `number of days` the key should be active which `starts at the time of activation` (procurement date).

4. A School IT Personnel can `delete` a key while the status is still `inactive` and also can `not create` a key while the status is `inactive`.



## System Credentials - Testing ⚙️



**Admin**



-   Email - `accessportalinfo@gmail.com`

-   Password - `admin`



**School IT Personnel(s)**



-   Email - `julius.markwei@stu.ucc.edu.gh`

-   Password - `guest@123`



---



-   Email - `tiktechgh@gmail.com`

-   Password - `guest@123`



---



-   Email - `juliussingh23k@gmail.com`

-   Password - `guest@123`



The project was inspired by the need for a robust and efficient way to manage access keys for a multi-tenant school management platform. Every aspect of this project required extensive research and careful planning to ensure seamless integration and functionality. The activities involved in this project are as follows:



1. Database model (table) development and configurations

2. Writing the various API views for all the neccessary methods of each view

3. Admin panel management configurations.

4. Adding all the neccesary URL endpoints to for all the various views and thier methods. Not forgetting the admin panel too.

5. Writing tests for all the views and thier methods. I also used Postman for testing as well.

6. Including a documentation for the project API through a library called drf-spectacular by OpenAPI Initiative.

7. Deployment of the REST API to heroku



## Image of the Browsable API





    




## Technologies utilized in developing the system



1. **Django rest Framework** for handling API views, and routes.

2. **Celery** was utilized for managing and executing asynchronous background tasks, ensuring that long-running processes do not block the main application.

3. **Celery Beat** was employed as a scheduler to automate the execution of periodic tasks, enabling tasks to run at defined intervals without manual intervention.

4. **Redis** as a message broker for Celery to manage and schedule background tasks.

5. **Postgres Database** as the primary database for storing application data securely and efficiently.

6. **DRF Spectacular** for generating and maintaining OpenAPI documentation for the Django REST Framework API.



## Frontend technoloies used



1. **Next.js** for building the frontend, providing server-side rendering and static site generation for a seamless user experience.

2. **Vercel** was used host the frontend application, ensuring fast and reliable hosting with seamless integration for continuous deployment.



## Images of the Frontend



1. Admin View




 








2. School IT Personnel View




 










-   Frontend repository can be found  `here`



## Prerequisites



```

    python -> 3.10

    django -> 5.0.4

    djanforestframework -> 3.15.1

    celery -> 5.4.0

    redis -> 5.0.4

```



## Installation



1. #### Clone this repository



```

    git clone https://github.com/juliusmarkwei/access-portal.git

    cd access-portal/

```



2. #### Install all the neccessary packages/dependencies



```

    pip install -r requirements.txt

```



3. #### Environment Variables



-   Create a `.env` preferrably inside the root directory access-portal/. Inside the .env add a SECRET_KEY and your database configurations of the database of your choice. You can generate a `SECRET_KEY` using the following code snippet:



```

    from django.core.management.utils import get_random_secret_key

    print(get_random_secret_key())

```



-   Check the complete list of the `.env` file content here. It should look like the variables below:



```

    SECRET_KEY=your_secret_key_here

    DB_HOST=your_db_host

    DB_USER=your_db_user

    DB_PASSWORD=your_db_password

    DB_NAME=your_db_name

    DB_PORT=your_db_port

    DB_ENGINE=your_db_engine

```



4. In the root directory of the project, create a superuser to manage all the users of the application. be sure python is installed before you proceed with this stage.



```

    python3 manage createsuperuser

```



5. #### Run the program with the following command



```

    python3 manage runserver

```



6. #### Start the celery worker and celery beat



```

    celery -A core worker --loglevel=info

    celery -A core beat --loglevel=info

```



-   Make sure your redis server is up and running before you run the comand above.



## Get Involved



I welcome contributions and participation from the community to help make this backend API even better! Whether you're looking to fix bugs, add new features, or improve documentation, your help is greatly appreciated. Here's how you can get involved:



### Reporting Issues 🚩



If you encounter any bugs or issues, please report them using the  Issues section of my GitHub repository. When reporting issues, please include:



-   A clear and descriptive title.

-   A detailed description of the problem, including steps to reproduce it.

-   Any relevant logs or error messages.

    Your environment details (e.g., Django version, DRF version, database, etc.).



### Contributing Code 💁🏼



I love receiving pull requests from the community! If you have an improvement or a new feature you'd like to add, please feel free to do so 👍