The File Management Application is a Python application built using the FastAPI framework, designed for fast development and simplicity.
Prerequisites:
- Python >= 3.7 installed
- virtualenv installed
To get started with the development of this application, follow the steps below:
-
Create and Activate a Python Virtual Environment
First, create a Python virtual environment to isolate the application's dependencies:
$ virtualenv .venv $ source .venv/bin/activate
-
Install Application Dependencies
After activating the virtual environment, install the required dependencies:
$ make deps-install
-
Start the Application
Once the dependencies are installed, you can start the application with the following command:
$ make app-run-dev
This command will launch the application in development mode, allowing you to test and make changes conveniently. The application will listen on port
3000
by default.
Note: Depending on your specific setup, you might need to export environment variables to configure certain settings. Please refer to settings.py to identify which environment variables are required.
Ensure that you set these environment variables properly to avoid encountering any errors during application execution.
With these instructions, you're all set to begin working on the File Management Application.
Happy coding!
For architecture design, please refer to Architecture Design