Skip to content

Latest commit

 

History

History
110 lines (74 loc) · 4.27 KB

README.md

File metadata and controls

110 lines (74 loc) · 4.27 KB
Raw

🎮 Games We Want 🎮

Games We Want is a web app 🌐 that provides users with information about various games 🕹️, including details on the best games and more. Users can also manage their accounts 👥 and favorites ❤️.

If you have a want some information before buying a game, this is here you can find it! 🧐

🚀 Features

  • 👀 See the top games of all times, search deep inside the list using the pagination.
  • 🆔 Create your own account with your personal information and authenticate you to start using all the features.
  • From here, you will be able to:
    • 🔍 Search for particular games.
    • 📚 See detailed information about the games (reviews, description, important dates, screenshots, platforms, companies...).
    • ❤️ Manage your favorite games to easy find them on your personnale page, as well as your personnal information.
    • 🗑️ Delete your account...
    • 🎉 ...and more !

📱 Application

You can use this application to see information about the games that you want. Here is a visual of some pages of the application:

The current visual of the application with various pages where you can find information about games.

This web application may be used in many small projects to make a simple but working application or for search related works. 🕵️‍♀️🕵️‍♂️

💻 Languages and Technologies Used

🚧 The application uses an API hosted by someone else. The API used uses igdb to retrieve the games data. The application may be broken at the time you launch it. Maybe a day, a permanent solution will be implemented to avoid a potential death of the application.

📚 Prerequisites

Currently the application is deployed with Vercel. You can find the latest deployment here and test the application without any soft excepted a web browser. 🌐

If you prefer to run it locally, the following dependencies are required:

🏃‍♂️ How to Run the application locally

  1. 📥 Clone the repository.
  2. 📁 Open the solution under src/ on Visual Studio Code or your prefer IDE.
  3. 📦 Make sure you have npm installed and node.js > 20.x, and then at the src/ folder, run the following commands:
# Install the required dependencies, may take some time.
npm install

# Run the application locally.
npm run dev
  1. 🚀 The solution will be build and you can go on the link displayed on your console, you will see the application running.
  2. 🌟 You can start creating an account and trying the app. Enjoy !

📖 Documentation

You can find the application documentation under the doc/. 📚

Actually, apart some screenshots, there is not a lot of doc. 📸

🤝 How to Contribute

  1. Fork the repository 🍴
  2. Create a new branch with your feature 🌿
  3. Commit your changes 💾
  4. Push to your branch 🚀
  5. Create a pull request 📬

If you need a something related to the application, please contact us. 📞

👥 Authors

TREMBLAY Jérémy

CROISIER Maxime

📝 License

I want to leave the possibility to other people to work on this project, to improve it and to make it grow, that's why we decided to place it under MIT license. 📜

Read more about the MIT licence.

You can use it for a search project or just for your personnal use.
If you use the Games We Want web application in your projects, please just cite our repository as follows:

@misc{GamesWeWant2024,
author = {Jérémy Tremblay & Maxime Croisier},
title = {Games We Want: Visualize game data},
year = {2024},
howpublished = {\url{https://github.com/JeremyTremblay2}},
note = {Version 1.0}
}