Skip to content
This repository has been archived by the owner on Jan 2, 2025. It is now read-only.

Commit

Permalink
docs(readme): archive notice
Browse files Browse the repository at this point in the history
  • Loading branch information
ElioDiNino authored Jan 2, 2025
1 parent bfe363b commit e1ecc9e
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@

# 3FA

> [!IMPORTANT]
> This project is now archived. [Running the source code yourself](#setting-up-your-own-servers) will still work as expected, but dependencies are no longer being kept up to date and active development has ended.
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.

[![Status Page](https://img.shields.io/badge/Status%20Page-2a853f?style=for-the-badge)](https://computing-collective.github.io/3FA-Status/)
Expand Down Expand Up @@ -43,7 +46,7 @@ https://github.com/Computing-Collective/3FA/assets/52972357/1cd9538f-6b38-4530-9
2. You can then create an account and start using the application by uploading and managing files.
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**:
> [!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. 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

0 comments on commit e1ecc9e

Please sign in to comment.