A directory listing service that lists a directory's contents and the size of it's contents. Result is ordered by size
It includes
- a cli for running it via the command prompt
- a flask app that exposes an api endpoint and
- a react application
- Clone repository
- Setup a python virtualenv
- Run the cli on a directory
python ./listx.py /User/<username>/Downloads
- Install python dependences (this project uses Poetry for managing dependences)
poetry install
- Start application
flask run
- Navigate to
http://localhost:5000/api/listx?path=/Users/<username>/Downloads
-
Make sure the api is running see API Section
-
Ensure you have the latest LTS node is installed as well as yarn
-
Navigate to app and install node modules
yarn install
- Start the application
yarn dev
- Containerize application (using docker or kubernters :))
- Install a production server for backend / frontend
- Add more checks to catch errors
- Paginate response
- Add tests