Skip to content

Commit

Permalink
Merge pull request #94 from Computing-Collective/api-docs
Browse files Browse the repository at this point in the history
API Documentation Additions
  • Loading branch information
ElioDiNino authored Aug 1, 2023
2 parents bfa1fac + 0472fd6 commit d24b2cf
Show file tree
Hide file tree
Showing 5 changed files with 4,129 additions and 16 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

A secure and scalable multi-factor authentication system including a client application, admin dashboard, and backend server. The implementation seen here implements a secure file storage system but the underlying authentication system could be used for any application.

[View the live status page](https://computing-collective.github.io/3FA-Status)
[![Status Page](https://img.shields.io/badge/Status%20Page-2a853f?style=for-the-badge)](https://computing-collective.github.io/3FA-Status/)

## Table of Contents
- [3FA](#3fa)
Expand Down Expand Up @@ -44,7 +44,7 @@ https://github.com/Computing-Collective/3FA/assets/52972357/1cd9538f-6b38-4530-9
3. The admin dashboard can be found at [3fa.netlify.app](https://3fa.netlify.app/). You can use the account `admin@3fa.com` with the password `Password1` to login. Note that you will have to login to the client application with these credentials first.

> **Note**:
> To avoid having to construct the microcontroller device yourself, you can use either sign up with accounts that do not use the sensor password option or you can use the [mock device script](/embedded/demo/mock_pico.py) in the embedded folder along with a REST client like Postman to authenticate with the server (not recommended without a thorough understanding of the system). If you choose the latter option, you will benefit from reading [`API.md`](/admin-system/backend/API.md) to better understand the API.
> To avoid having to construct the microcontroller device yourself, you can use either sign up with accounts that do not use the sensor password option or you can use the [mock device script](/embedded/demo/mock_pico.py) in the embedded folder along with a REST client like Postman to authenticate with the server (not recommended without a thorough understanding of the system). If you choose the latter option, you will benefit from reading [`API.md`](/admin-system/backend/API.md) to better understand the API. You can also import the [Postman collection](admin-system/backend/postman-collection.json) and [Postman environment](admin-system/backend/postman-environment.json) to get started.
### Setting up your own servers

Expand Down
Loading

0 comments on commit d24b2cf

Please sign in to comment.