Chalkboard-Games

• Deployed to GH-Pages: https://daydin14.github.io/chalkboard-games/

Table of Contents

• Getting Started
• Features
• Technologies Used
• Screenshots
• Deployment on GitHub Pages

Getting Started

To get started with the project, follow these steps:

1. Fork the repository: Click the "Fork" button at the top right of this repository to create a copy of the repository in your GitHub account.
2. Clone the repository: Clone the forked repository to your local machine using the following command:

   git clone https://github.com/<your-username>/chalkboard-games.git

3. Navigate to the project directory: Change into the project directory:

   cd cg-app

4. Open with VS Code: Using the terminal, after you've changed directory into the project:

   code .
   //Daves Side Note: '.' is similar to saying, code "current directory"

5. Install dependencies: Install the required dependencies using npm:

   npm install || npm i

6. Start the development server: Start the development server to run the application locally:

   npm start

Features

• Single-Page Application: Built using React, providing a smooth and responsive user experience.
• Google Maps Integration: Utilizes the Google Maps API to display business information and location.
• Google Analytics Integration: Tracks and analyzes user interactions to provide insights into user behavior and application performance.
• Tailwind CSS: Styled using Tailwind CSS for a utility-first approach to design.
• DaisyUI: Utilized DaisyUI components for a modern and consistent design.

Technologies Used

IDEs/Editors

• VS Code: A powerful, lightweight code editor with built-in support for JavaScript, TypeScript, and Node.js.

Languages

• JavaScript (JS): The main programming language used for building the application.
• HTML: Used for structuring the web pages.
• CSS: Used for styling the web pages.
• Markdown (MD): Used for writing documentation.

Version Control

• Git: A distributed version control system for tracking changes in source code.
• GitHub: A web-based platform for version control and collaboration.

Frameworks, Platforms, and Libraries

• NPM: A package manager for JavaScript, used to install dependencies.
• React: A JavaScript library for building user interfaces.
• React Router: A library for routing in React applications.
• Tailwind CSS: A utility-first CSS framework for rapidly building custom user interfaces.
• DaisyUI: A plugin for Tailwind CSS that provides a set of accessible and customizable UI components.

Screenshots

Deployment on GitHub Pages

This project uses the gh-pages node package to deploy the application to GitHub Pages. Follow these steps to deploy your application:

1. Install gh-pages: Install the gh-pages package as a development dependency:

   npm install gh-pages --save-dev

2. Update package.json: Add the following scripts to your package.json file:

   "scripts": {
       "predeploy": "npm run build",
       "deploy": "gh-pages -d build",
       "start": "react-scripts start",
       "build": "react-scripts build",
       "test": "react-scripts test",
       "eject": "react-scripts eject"
   }

3. Add homepage field: Add the homepage field to your package.json file with the URL of your GitHub Pages site:

   "homepage": "https://<your-username>.github.io/allenhurstcleaners_v2"

4. Deploy the application: Run the deploy script to build and deploy the application to GitHub Pages:

   npm run deploy