Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/dantelentsoe/cryptographic_messages


https://github.com/dantelentsoe/cryptographic_messages

Last synced: 1 day ago
JSON representation

Awesome Lists containing this project

README

        

# cryptographic_messages

This app is a simple text encrption algorithm, designed to help add a layer of security to your day to day texting :-) enjoy

## Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

### Prerequisites

- [Python](https://www.python.org/) minimum v3.3.0

### Installing

- Clone the repository using SSH

```
git clone https://github.com/DanteLentsoe/cryptographic_messages.git
```

- Navigate to the cloned repo

```
cd cryptographic_messages
```

## Running the tests

- To run tests normally, use

### Detail testing methods

- To run tests with coverage reporting, use

```
python -m unittest
```

## Environments

There are 2 environments each corresponding to a branch on the repository:

- Production - `master` branch
- Development - `dev` branch

## Deployment

The application is deployed on [Repl.it](```https://.repl.it```)

## Built With

Details of the tech stack that has been used.

- [Python](https://www.python.org/)

## Architecture

A basic architecture diagram or description of the chosen architecture should be detailed here. Lol, I did not include it.

## Contributing

Please read [CONTRIBUTING.md](https://gist.github.com/DanteLentsoe/Help-an-en-eye-gee-gee-ay) for details on the followed standards standard for commit messages and the accepted pull request process.

## Authors

- **Dante Lentsoe**

## Licenses

```
├─ MIT: 953
├─ ISC: 78
├─ BSD-3-Clause: 37
├─ BSD-2-Clause: 29
├─ Apache-2.0: 26
├─ MIT*: 8
├─ BSD: 5
├─ (MIT OR CC0-1.0): 5
├─ CC0-1.0: 4
├─ WTFPL: 2
├─ Unlicense: 2
├─ 0BSD: 2
├─ Custom: https://github.com/tmcw/jsonlint: 1
├─ BSD-3-Clause OR MIT: 1
├─ (MIT OR Apache-2.0): 1
├─ CC-BY-4.0: 1
├─ Public Domain: 1
├─ AFLv2.1,BSD: 1
├─ (MIT AND Zlib): 1
├─ (MIT AND BSD-3-Clause): 1
└─ CC-BY-3.0: 1
```

## Troubleshooting

Here is a list of common errors and possible solutions:

Failed to push to Github due to out of date snapshots:

- Run

> python3 main.py

## Meta

| Version | Author | Date |
| ------- | ----------------------------------- | ---------- |
| 0.0.1 | Dante Lentsoe | 22/08/2021 |