Skip to content

kha1ne/diu6p

Repository files navigation

Dune Imperium: Uprising 6p Table Generator

A simple Hello World application built with React and TypeScript. This project is intended to be a minimal barebone setup with essential dependencies for building and testing a React application using TypeScript.

Table of Contents

Project Overview

This repository contains a minimal setup for a React project using TypeScript. The project includes configurations for testing with Jest and Testing Library, as well as Babel plugins for handling modern JavaScript features.

Getting Started

Prerequisites

Ensure you have the following installed:

  • Node.js (version 16.x or higher recommended)
  • Corepack (included with Node.js 16.10+)
  • Yarn 4 (managed via Corepack)

Installation

Clone the repository and install the dependencies:

git clone git@github.com:kha1ne/diu6p.git
cd diu6p
corepack enable
corepack prepare yarn@4.9.1 --activate
yarn install

Running the Application

To start the development server, run:

yarn start

This will start the app at http://localhost:3000. The page will automatically reload if you make edits.

Building the Application

To build the app for production, run:

yarn build

The production-ready code will be in the build folder.

Testing

This project uses Jest and Testing Library for unit and integration testing.

To run the tests, execute:

yarn test

Coverage reports are generated automatically and can be found in the coverage folder after running the tests.

Project Structure

diu6p/
├── public/                 # Static assets
├── src/                    # Application source code
│   ├── components/         # React components
│   ├── __tests__/          # Test files
│   ├── index.tsx           # Entry point for React
│   └── setupTests.ts        # Jest setup file
├── package.json            # Project metadata and dependencies
└── tsconfig.json           # TypeScript configuration

Scripts

  • yarn start: Starts the development server.
  • yarn build: Builds the project for production.
  • yarn test: Runs the tests with coverage.
  • yarn eject: Ejects the configuration (if needed).

License

This project is licensed under the MIT License. See the LICENSE file for more information.

About

Dune Imperium: Uprising Table Generator for Six Players

Topics

Resources

License

Stars

Watchers

Forks