sander1095/polar-dash

Polar-Dash: 🎃 Hacktoberfest 2023 Project 👻

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

Table of Contents
Introduction
Project Overview
Getting Started
Contributing
Technical Details
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:

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.
Clone the Repository: Clone your forked repository to your local machine.
```
git clone https://github.com/your-username/polar-dash.git
```
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
```

TODO: Set up instructions for Azure Static WEb App + database (dab cli, connectionstring env var, get access or create your own, etc..)

TODO: Document dab cli. For example, you can use dab add TriviaQuestion --source dbo.TriviaQuestion --permissions "anonymous:read" -c staticwebapp.database.config.json to add an entity to the API.

TODO: Figure out roles.

Start Development Server: Start the development server to see the app in action.
```
npm start
```
Create a New Branch: Create a new branch for your contributions.
```
git checkout -b my-feature-branch
```
Make Changes: Make your desired changes to the codebase.
Commit Changes: Commit your changes with a descriptive commit message.
```
git commit -m "Add feature XYZ"
```
Push Changes: Push your changes to your forked repository.
```
git push origin my-feature-branch
```
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! 🐻❄️🎉

sander1095 / polar-dash