Sneaker Portfolio is an interactive Website which allows you to track your shoe collection in a visual portfolio. You can search, add, and remove shoes in order to keep it up to date. The portfolio can be presented in any order and includes features such as a random picker 🎲. Not only can you show off your collection easier to your friends, but you can also make yourself a better picture on what shoes you could buy next.
[CLICK TO EXPAND]
BEFORE YOU START THE APPLICATION:
- The variable
REACT_APP_API_URL
has to be configured to the URL the application will be running on. If you run it on your local machine, it has to be configured tohttp://localhost:8000/
. - To configure the variable, add a
.env
file insneaker-frontend
similar to the.env.template
found in the same folder
We heavily encourage running the application through Docker. Run docker-compose up
to start it on default port 8000
.
If you want to run the application locally, installing Python 3.11
, poetry
, nodejs
and npm
is necessary.
Using conda is recommended for the Python setup.
Commands with conda
If you are using conda, run:-
conda create -n sneaker python=3.11
-
conda activate sneaker
-
pip install poetry
To run the application, run these commands:
make install-server
make build
make server
make install-server
to install dependencies.make server
to start the Python FastAPI backend server on default port8000
.
make build
to install dependencies and generate static webpages with React. These webpages can then be served by the backend.make frontend
starts a webserver serving the websites on default port3000
.
- Creation of new users via the Frotnend. Currently, there is a fix amount of users added by hand to the database.
- Insertion of custom entries, in case StockX does not have a shoe available.
- ...