Skip to content

Commit

Permalink
Create README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
zoroxide authored Apr 3, 2024
1 parent a620ced commit ae5050f
Showing 1 changed file with 61 additions and 0 deletions.
61 changes: 61 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
# PyNAS v1.0

PyNAS is a simple Network Attached Storage (NAS) server built with Python and Flask. It allows users to upload, organize, download, and delete files and folders through a web interface.

## Screen Shoots
![1](https://github.com/Egypt-Open-Source/PyNas/assets/72279810/743a171d-e662-44fc-9295-35e451e2e9dc)
![2](https://github.com/Egypt-Open-Source/PyNas/assets/72279810/55874bca-bb81-4a2b-b711-cbc11202da01)
![3](https://github.com/Egypt-Open-Source/PyNas/assets/72279810/0180fc8c-61be-4f1f-b020-d41ab78dd7f9)

## Features

- Upload files to the server.
- Organize files into folders.
- Download files from the server.
- Delete files and folders from the server.
- Responsive UI with Bootstrap.

## Installation

1. Clone the repository:

```bash
git clone https://github.com/Egypt-Open-Source/PyNas.git
```

2. Navigate to the project directory:

```bash
cd PyNAS
```

3. Install dependencies:

```bash
pip install -r requirements.txt
```

4. Run the application:

```bash
python app.py
```

5. Access the application in your web browser at `http://localhost:5000`.

## Usage

- Upon accessing the application, you'll be presented with a simple interface.
- Use the navigation bar to navigate between different sections of the application.
- On the home page, you can upload files by providing an optional folder name and selecting a file to upload.
- Navigate to the "Files" page to view all uploaded files and folders.
- Click on a folder name to view its contents.
- You can download files by clicking on their names, and delete files and folders using the provided links.
## Contributing
Contributions are welcome! If you'd like to contribute to this project, please open an issue or submit a pull request.

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

0 comments on commit ae5050f

Please sign in to comment.