Skip to content

Commit

Permalink
chore: adding user documentation in README file
Browse files Browse the repository at this point in the history
  • Loading branch information
RawanMostafa08 committed Oct 21, 2024
1 parent cf45251 commit 042611e
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 1 deletion.
43 changes: 42 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,42 @@
# Secret-Note-MVC-Rawan-Mostafa
# Secret-Note Application

This repository implements a Secret Note Sharing Application, it's a web application that allows users to securely share self-destructing secret notes.

The notes are created with a random url that can't be easily guessed, has self destruction feature using maximum views or expiration time

## Table of Contents

- [features](#features)
- [Installation](#installation)
- [Usage](#usage)

## Features
- Note Creation :

- Users can create a note with text content
- Generate a unique, secure URL for each note
- Set an expiration time or number of views before destruction
- Note Retrieval :

- Users can view a note using the unique URL
- After viewing or upon expiration, the note is permanently deleted
- Security Features:

- We use secure random generation for URLs so that the urls aren't predictable

## Installation

Clone the repository

```bash
git clone https://github.com/codescalersinternships/Secret-Note-MVC-Rawan-Mostafa.git
```

## Usage
Run the docker container using docker-compose
```bash
docker-compose up
```
You'll then find the url of your app printed in the terminal, and here you go you can signup and start making notes securely!

![alt text](image.png)
Binary file added image.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 042611e

Please sign in to comment.