open-source-indie / polar-dash

Het gezelschapsspel voor Arcadians, door Arcadians.

Polar-Dash: 🎃 Hacktoberfest 2023 Project 👻

Welcome, Arcadians, to the "Polar-Dash" Hacktoberfest 2023 project! 🚀

Table of Contents

1. Introduction
2. Project Overview
3. Getting Started
4. Contributing
5. Technical Details
6. License

Introduction

This repository is dedicated to the creation of "Polar-Dash," an exciting single-page quiz game built from scratch using React. As a part of Hacktoberfest 2023, we aim to develop a fun and engaging quiz game that will showcase our collective coding skills and creativity.

Project Overview

• Name: Polar-Dash

• Objective: To create a single-page-app for tablet quiz application using React for Hacktoberfest 2023.

• Hardware Requirements: A tablet with Google Chrome as webbrowser

• Hacktoberfest Credits: Make sure to register @ https://hacktoberfest.com/

Getting Started

To get started with contributing to "Polar-Dash," follow these steps:

1. Fork the Repository: Click the "Fork" button on the top right of this GitHub page to create a copy of this repository in your own GitHub account.

2. Clone the Repository: Clone your forked repository to your local machine.

   git clone https://github.com/your-username/polar-dash.git

3. Install Dependencies: Navigate to the project's root directory, install the required dependencies and build the project.

   cd polar-dash
   npm install
   npm run build

4. Start Development Server: Start the development server to see the app in action.

   npm start

5. Create a New Branch: Create a new branch for your contributions.

   git checkout -b my-feature-branch

6. Make Changes: Make your desired changes to the codebase.

7. Commit Changes: Commit your changes with a descriptive commit message.

   git commit -m "Add feature XYZ"

8. Push Changes: Push your changes to your forked repository.

   git push origin my-feature-branch

9. Open a Pull Request: Go to the original repository on GitHub and click "New Pull Request" to submit your changes for review.

Contributing

We encourage all Arcady colleagues to join in the development of "Polar-Dash" for Hacktoberfest 2023. Whether you are an experienced developer or just starting, your contributions are valuable. Please follow our Contributing Guidelines for more details.

Technical Details

• Technology Stack: React
• Development Environment: Node.js
• License: MIT License (See LICENSE for details)

License

This project is licensed under the MIT License - see the LICENSE file for details.

Happy coding, and let's make "Polar-Dash" a fantastic Hacktoberfest project together! 🐻❄️🎉

---