https://github.com/olehkavetskyi/fileuploadingsystemapi
https://github.com/olehkavetskyi/fileuploadingsystemapi
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/olehkavetskyi/fileuploadingsystemapi
- Owner: olehkavetskyi
- Created: 2023-03-28T23:10:19.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-04-26T07:55:57.000Z (about 2 years ago)
- Last Synced: 2025-02-03T23:41:25.553Z (4 months ago)
- Language: C#
- Size: 119 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# API
File uploading system was created to test my practical skills of C#, Microsoft Azure and front-end.
This app represents a form that takes user's email and a file with '.docx' extension. It sends to the server where API part saves the file to Azure Blob Storage. In case of success azure function is triggered and with SendGrid sends notification about success to the user.
## Installation
To install the API repository, follow these steps:
1. Clone the repository to your local machine using Git.
```bash
git clone https://github.com/olehkavetskyi/FileUploadingSystemAPI
```
2. Install the .NET 6 on your machine if it is not already installed.
3. Navigate to the root of the repository using the command prompt.
4. Run the command dotnet restore to install the dependencies.
## Usage
To use the API repository, follow these steps:
1. Create an Azure Blob storage account in the Azure portal.
2. Create an Azure Function App in the Azure portal.
3. Configure the Azure Function App to use the Blob storage account as a trigger.
4. Run the command dotnet run to start the Azure Function App.
5. Upload a .docx file to the Blob storage to trigger the Azure Function App and send an email notification.
## TODO
1. Unit tests
2. Telegram bot that takes a key word from a user, search in a database files that is contain this key word and return to the user as a message with files?
3. If the file was downloaded the user can try to contact someone who posted this file (user tap the button 'Request to show an author email after that the author gets an email with this request. The author can confirm or deny it')?
4. Remove compiled Angular code
## Deployment
To deploy the API repository to an Azure Function App, follow these steps:
1. Navigate to the Deployment Center of the Azure Function App and choose GitHub as the source.
2. Select the API repository and configure the deployment options.
3. Wait for the deployment to finish and test the Azure Function App by uploading a .docx file to the Blob storage.
## Links
In order to see UI part follow [this](https://github.com/olehkavetskyi/FileUploadingSystemUI) link
A link to Azure Web Application - https://fileuploadingsystem.azurewebsites.net (deactivated)