https://github.com/mapledevjs/email-audit
https://github.com/mapledevjs/email-audit
react typescript
Last synced: 8 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/mapledevjs/email-audit
- Owner: mapleDevJS
- Created: 2024-05-27T01:33:51.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-04-11T22:19:08.000Z (25 days ago)
- Last Synced: 2025-04-28T16:05:51.985Z (8 days ago)
- Topics: react, typescript
- Language: TypeScript
- Homepage: https://email-audit.netlify.app
- Size: 660 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Email Audit [](https://app.netlify.com/sites/email-audit/deploys)
Email Audit is a system used to audit all emails sent from within an organization. In the event of security incidents (such as leakage of sensitive information via emails), this system will be used by the organization's auditing department to retrieve and verify the emails of the concerning parties through its admin console.
## Project Setup
Before starting the development or building the project, make sure you are in the correct project folder (i.e., the `react` folder). Also, refer to the additional tasks and challenges on the `challenge_details/CHALLENGE.md` file.
## Development
To start with the development, initially install the dependencies and then run the project in the development mode.
```bash
npm install
npm run dev
```
After running these commands, navigate to the port that was displayed on the terminal. The app should be running after the development build is finished.
## Build
To generate a production version, use the following command:
```bash
npm run build
```
You can run the newly built app locally with `npm run preview`.
## Features
This project is in an early phase, so the features are not yet complete. At the moment, it will display mocked email data from `fake-data.ts` to simulate an API response. It also doesn't have any kind of pagination at the moment, but we plan to support it in the future, as well as allowing the user to set how many items to show per page.
Since checking date and time is crucial in an auditing process, table rows have alternating background colors between dates to make it easier to distinguish emails sent on different dates. Our users are diverse and have many different device configurations, so we need to make sure the UI doesn't break when viewed at any screen size. However, since we haven't implemented a _mobile version_ of the design yet, we understand that the information cannot be consumed well on very small screen sizes.