Skip to content
This repository has been archived by the owner on Dec 1, 2024. It is now read-only.

Commit

Permalink
chore: Update repository links and references to reflect new GitHub u…
Browse files Browse the repository at this point in the history
…sername
  • Loading branch information
dikayx committed Aug 22, 2024
1 parent 0e3ee24 commit 6b4f0e5
Show file tree
Hide file tree
Showing 5 changed files with 12 additions and 12 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

[![Python3](https://img.shields.io/badge/Python-3.10-blue.svg)](https://www.python.org/downloads/release/python-3100/)
[![License](https://img.shields.io/badge/License-MIT-lightgrey.svg)](LICENSE)
[![Build Status](https://github.com/dan-koller/mapy/actions/workflows/python-app.yml/badge.svg)](https://github.com/dan-koller/mapy/actions/workflows/python-app.yml)
[![Build Status](https://github.com/dikayx/mapy/actions/workflows/python-app.yml/badge.svg)](https://github.com/dikayx/mapy/actions/workflows/python-app.yml)

MAPy is a small utility tool for **M**ail **A**nalysis in **Py**thon inspired by CyberDefenders' [Email-Header-Analyzer](https://github.com/cyberdefenders/email-header-analyzer). It is designed to help you parse email data and extract useful information from it.

Expand All @@ -21,7 +21,7 @@ MAPy is a small utility tool for **M**ail **A**nalysis in **Py**thon inspired by

## Get started

Download the latest release from the [releases page](https://github.com/dan-koller/mapy/releases) and use the [setup.sh](setup.sh) (Mac & Linux) or [setup.bat](setup.bat) (Windows) script to set up the app via Docker or locally. For more detailed instructions, see the [installation guide](docs/INSTALLATION.md).
Download the latest release from the [releases page](https://github.com/dikayx/mapy/releases) and use the [setup.sh](setup.sh) (Mac & Linux) or [setup.bat](setup.bat) (Windows) script to set up the app via Docker or locally. For more detailed instructions, see the [installation guide](docs/INSTALLATION.md).

If you are already familiar with Git, you can use the commands below to clone the repository and run the setup script.

Expand All @@ -30,13 +30,13 @@ If you are already familiar with Git, you can use the commands below to clone th
To get the app up and running on Mac or Linux, run:

```bash
git clone https://github.com/dan-koller/mapy.git && cd mapy && chmod +x setup.sh && ./setup.sh
git clone https://github.com/dikayx/mapy.git && cd mapy && chmod +x setup.sh && ./setup.sh
```

On Windows, open a command prompt (cmd) and run:

```cmd
git clone https://github.com/dan-koller/mapy.git && cd mapy && setup.bat
git clone https://github.com/dikayx/mapy.git && cd mapy && setup.bat
```

Follow the instructions in the terminal to start the app. By default, it will be available at [http://localhost:8080](http://localhost:8080). If you want to use SSL, see the [Securing the app with SSL](docs/INSTALLATION.md#securing-the-app-with-ssl) section in the installation guide.
Expand Down
4 changes: 2 additions & 2 deletions docs/INSTALLATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ MAPy requires Python 3.10 or higher to run locally.
1. Clone the repository

```bash
git clone https://github.com/dan-koller/mapy
git clone https://github.com/dikayx/mapy
```

2. Create a new virtual environment\* & activate it
Expand Down Expand Up @@ -97,7 +97,7 @@ You can also use the `docker-compose.yml` file to run the app. Just run `docker-
1. Clone the repository

```bash
git clone https://github.com/dan-koller/mapy
git clone https://github.com/dikayx/mapy
cd mapy
```

Expand Down
2 changes: 1 addition & 1 deletion docs/SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,6 @@ MAPy tries to follow the latest security best practices and recommendations. As

## Reporting a Vulnerability

If you discover a security issue in MAPy, please [create an issue](https://github.com/dan-koller/mapy/issues). I take security seriously and will do my best to address the issue promptly.
If you discover a security issue in MAPy, please [create an issue](https://github.com/dikayx/mapy/issues). I take security seriously and will do my best to address the issue promptly.

If you have any contributions or suggestions to improve the security of MAPy, feel free to open a pull request. Your help is greatly appreciated!
2 changes: 1 addition & 1 deletion docs/TESTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ pytest

This will run all the tests in the `tests` directory and output the results in the terminal. If all tests pass, you should see a message indicating that all tests have passed successfully.

That's it! You are now ready to contribute to the project by adding new features, fixing bugs, or improving the existing codebase. If you have any questions or need help with anything, feel free to [open an issue](https://github.com/dan-koller/mapy/issues) or reach out to me directly.
That's it! You are now ready to contribute to the project by adding new features, fixing bugs, or improving the existing codebase. If you have any questions or need help with anything, feel free to [open an issue](https://github.com/dikayx/mapy/issues) or reach out to me directly.

## Coverage

Expand Down
8 changes: 4 additions & 4 deletions mapy/templates/base.html
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@
<li class="nav-item">
<a
class="nav-link"
href="https://github.com/dan-koller/mapy"
href="https://github.com/dikayx/mapy"
>
<img
src="../static/img/github-mark-white.svg"
Expand All @@ -68,7 +68,7 @@
<!-- Fork ribbon (only on the home page) -->
{% if request.method == "GET" and request.path == "/" %}
<div>
<a href="https://github.com/dan-koller/mapy"
<a href="https://github.com/dikayx/mapy"
><img
decoding="async"
width="149"
Expand Down Expand Up @@ -97,7 +97,7 @@
<span class="text-muted">Made with ♡ by</span>
<span class="text-muted">
<a
href="https://github.com/dan-koller"
href="https://github.com/dikayx"
class="text-muted"
>Dan Koller</a
>
Expand All @@ -106,7 +106,7 @@
<div>
<span class="text-muted">
<a
href="https://github.com/dan-koller/mapy/blob/main/docs/USER_GUIDE.md"
href="https://github.com/dikayx/mapy/blob/main/docs/USER_GUIDE.md"
class="text-muted"
>Need help?</a
>
Expand Down

0 comments on commit 6b4f0e5

Please sign in to comment.