kwakyebrilliant/Auditra2
Brilliant Kwakye
Frontend Engineer
Web Developer
Solidity Engineer
Auditra
Auditing platform with Blockchain!
Explore the docs »
About The Project
What it does
Making use of blockchain technology, we present to you Auditra, an auditing platform that seeks simplify the auditing process with blockchain. By doing so, we offer you an easy way to perform the most challenging and complex audits more efficiently. And what we seek to achieve is to make the auditing processes more transparent to end users.
There are about two (2) user types (that is team and one auditor) that is captured on the platform. Among the two (2) user types, a user can perform an activity on the platform by choosing the user type they represent and then proceed to provide login details. The user is also to ensure that metamask is installed in their browser. Below are steps a user can undertake to perform an activity on the platform:
Click on connect wallet button in the navbar to load the user type modal.
Select the user type from the modal to fill login details.
Fill login details (login details: username: "user" password: "63CkBcD{B)h2>") and then click on submit button for a modal.
From the modal, click on continue to proceed to user dashboard. If metamask is not connected to the platform, the user will be prompted to connect or install metamask to continue the process.
Holla, you are now ready to use Auditra.
All media that are added as supporting documents in creating and submitting an audit are stored on IPFS.
Built With
This section should list any major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.
Getting started
The project consist of the backend and also the front end.
Prerequisites
nodejs installed
npm
Hardhat
Local setup
To run this project locally, follow these steps.
Start the local Hardhat node
npx hardhat node
With the network running, deploy the contracts to the local network in a separate terminal window
Configuration
The chain ID should be 80001. If you have a localhost rpc set up, you may need to overwrite it.
To deploy to Polygon test or main networks, update the configurations located in hardhat.config.js to use a private key and, optionally, deploy to a private RPC like Infura.
require('@nomiclabs/hardhat-waffle');
const privateKey = '';
module.exports = {
defaultNetwork: 'hardhat',
networks: {
hardhat: {
chainId: 1337,
},
mumbai: {
url: 'https://rpc-mumbai.maticvigil.com',
accounts: [privateKey],
},
matic: {
url: 'https://polygon-mainnet.g.alchemy.com/v2/OPAn_R_vIjcnM9MeCVVuvET9glKc1Y_l',
accounts: [privateKey],
},
},
solidity: {
version: '0.8.4',
paths: {
artifacts: './src/artifacts',
},
settings: {
optimizer: {
enabled: true,
runs: 1,
},
},
},
};
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
Fork the Project
Create your Feature Branch (
git checkout -b feature/AmazingFeature)Commit your Changes (
git commit -m 'Add some AmazingFeature')Push to the Branch (
git push origin feature/AmazingFeature)Open a Pull Request
License
Distributed under the MIT License.
Contact
Brilliant Kwakye - https://twitter.com/a_moah__
Mends Albert - https://twitter.com/mendalbert
Daniel Sarkodie - https://twitter.com/AbrantepaSark
