SteamGames

Welcome to SteamGames, a project that allows you to retrieve data about Steam users. It is mainly about how long it will take a user to beat thier entire steam library. This README will guide you on how to use the project effectively.

Getting Started

To get started, follow these steps:

1. Clone the repository to your local machine.
2. Open a terminal and navigate to the steamgames directory.
3. Start the database by running the following command:

docker-compose up

4. Open the project in your preferred IDE, such as IntelliJ.
5. Run the SteamGamesApplication class to start the backend.
6. Open the client folder in your terminal.
7. Run the following command to install the necessary dependencies:

npm install

8. Run the following command to start the client:

npm run dev

9. Once the client is running, open your browser and go to http://127.0.0.1:5174/.
10. In the input field, enter a Steam username to retrieve data about it.

Screenshots

Here's a screenshot of the project in action:

Feel free to explore the features and functionalities of the project!

Contributing

Contributions are welcome! If you have any suggestions, bug reports, or feature requests, please open an issue or submit a pull request.

License

This project is licensed under the MIT License. Feel free to use and modify the code as per your needs.

Acknowledgements

We would like to express our gratitude to the following resources and libraries that made this project possible:

• Docker - for containerization.
• IntelliJ - for the powerful IDE.
• npm - for package management.

Thank you for using SteamGames! If you have any questions or need further assistance, please don't hesitate to reach out.