Skip to content

Latest commit

 

History

History
66 lines (45 loc) · 1.77 KB

README.md

File metadata and controls

66 lines (45 loc) · 1.77 KB
Raw

Arcade Zone 🎮

Netlify Status

Arcade Zone is a game catalogue website built using ReactJS. It allows users to browse and search a large collection of games, view their details, and play them online.

Installation ⚙

To run the project locally, do the following:

  1. Clone the Git repository:

    git clone https://github.com/rootCircle/arcade-zone.git

  2. Navigate to the project directory:

    cd arcade-zone/client/arcade-zone

  3. Install the required dependencies using either Yarn or NPM:

    yarn

    or

    npm i

  4. Start the development server:

    yarn dev

    or

    npm run dev

Project Structure 🏗

The project is organized as follows:

  • client: Contains the front-end code written in ReactJS.
  • server: Contains the back-end code implementing the API endpoints.
  • public: Contains static assets such as index.html and images.
  • package.json: Defines the project dependencies and scripts.

Contributing 🤝

If you would like to contribute to Arcade Zone, please follow these steps:

  1. Create a fork of the project.
  2. Implement the feature or fix you want to add.
  3. Create a pull request, and get it reviewed before it is merged.
  4. If your pull request is accepted, congratulations! You have successfully contributed to the Arcade Zone project.

Please ensure that any code you contribute adheres to the coding standards and guidelines established by the project maintainers.

Resources 📚