RentApp is a rental platform with a unique approach compared to existing market options. Instead of searching for individual properties, users access apartments through their corresponding buildings. This design allows someone standing on the street to easily view available apartments in a building they select.
The project was developed in a single sprint, focusing on delivering a streamlined and innovative rental experience.
- Backend: Python with FastAPI framework.
- Database: MySQL.
- Frontend: React with Material UI and vanilla CSS.
- Docker: Used to containerize the application.
- Frontend-Backend Integration: Learned how to connect the frontend with the backend by making requests using various HTTP methods.
- Authentication and Security: Gained knowledge of implementing JWT (JSON Web Tokens) for secure user authentication.
- Requirement Elicitation: Learned how to conduct effective client interviews to gather and refine project requirements.
- User Stories: Documented requirements as user stories to ensure clarity and alignment with client expectations. Detailed user stories were created and managed using Trello. You can view the board here.
- Importance of Documentation: Understood the value of thorough documentation for both technical processes and project management.
- Docker installed on your system. You can download and install it from here.
-
Clone the project repository:
git clone https://github.com/gonblas/rentapp.git cd rentapp -
Build and start the docker container:
docker-compose up --build -d
-
Check if the containers are running:
docker ps
Now you can access the frontend at http://localhost:5173 and the Swagger Docs of the API at http://localhost:8000/docs.
- Make sure that ports 8000 and 5173 are available and not being used by another application.