? About The Project
File storage allows you to upload and download files using a simple API. This project can be used as a part of another project that needs to have a separate file storage
⚡️ Quick start
First of all, make sure you have installed Python. Version 3.6 or higher is required.
Download the repository and change the current directory:
git clone https://gitlab.com/swipio/file_storage.git && cd file_storage
Configure virtual environment. Make sure a .venv folder has been created after this step.
make venv
Run the project:
make up
Open the website http://localhost:5110/docs to view the API documentation
? Docker-way to quick start
Create the storage folder:
mkdir storage
Run the container:
docker run --rm -it \
-v "${PWD}/storage:/opt/app/storage" \
-p 5110:80 \
registry.gitlab.com/swipio/file_storage:latest
Open the website http://localhost:5110/docs to view the API documentation
? API documentation
There are two endpoints: for uploading and for downloading files. You can find more information about the API on the websitehttp://localhost:5110/docs (you need to run the project locally)
? Contributors
? All participants in this project are undergraduate students in the Department of Computer Science @ Innopolis University
? Vladimir Markov
Email: [email protected]
GitLab: @markovvn1
? License
API File storage is free and open-source software licensed under the Apache 2.0 License
