Table of Contents
There are many amazing game catalog websites out there, but Beyond Realms was built as a learning project with something special in mind: providing a simple yet interactive way to explore games using the RAWG API. Here's why Beyond Realms stands out:
- Focus on learning: This project is designed for anyone interested in understanding how to handle and integrate APIs in the frontend.
- Accessible code: Anyone can view the codebase to see how the RAWG API powers the site and is implemented in React with Tailwind CSS.
- Gaming made easy: Browse through games with an intuitive interface and discover your next favorite title.
Of course, this project is a work in progress. If you'd like to contribute or suggest improvements, feel free to check out the repository and dive into the world of API-based web development!
This project was built using several key technologies to ensure a responsive and dynamic experience for users. Here are the major frameworks and libraries that form the foundation of Beyond Realms:
These tools streamline the development process and enhance the website's functionality and performance.
This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.
This is an example of how to list things you need to use the software and how to install them.
- npm
npm install npm@latest -g
Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services.
-
Get a free API Key at https://rawg.io/apidocs
-
Clone the repo
git clone https://github.com/MohdAqdasAsim/Beyond-Realms.git
-
Install NPM packages
npm install
-
Enter your API in
config.jsconst API_KEY = `YOUR_API_KEY`; // Replace with your actual API key
-
Change git remote url to avoid accidental pushes to base project
git remote set-url origin your_github_username/your_repo_name git remote -v # confirm the changes
Here are some more screenshots of the website:
Contributions make the open-source community such an incredible place to learn, inspire, and innovate. Any contributions you make are greatly appreciated and help enhance this project.
If you have a suggestion to improve the project, feel free to fork the repo and submit a pull request. You can also open an issue with the "enhancement" tag. Don't forget to give the project a star if you find it helpful—thanks for your support!
Steps to Contribute:
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Distributed under the MIT License. See LICENSE.txt for more information.
Mohd Aqdas Asim - @mohdaqdasasim - [email protected]
Project Link: https://github.com/MohdAqdasAsim/Beyond-Realms
Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!