Skip to content

Commit

Permalink
lint/prettier
Browse files Browse the repository at this point in the history
  • Loading branch information
JessicaMulein committed Oct 16, 2024
1 parent b5ca62e commit cd3cb3b
Show file tree
Hide file tree
Showing 6 changed files with 19 additions and 895 deletions.
1 change: 0 additions & 1 deletion .eslintrc.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
/* eslint-disable @typescript-eslint/no-var-requires */
const typescript = require('@typescript-eslint/eslint-plugin');
const reactPlugin = require('eslint-plugin-react');
const reactHooksPlugin = require('eslint-plugin-react-hooks');
Expand Down
29 changes: 8 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# Unofficial Dominion Assistant

Welcome to the **Unofficial Dominion Assistant**, a React Native application designed to enhance your gameplay experience for the popular card game, Dominion! This tool provides comprehensive features for game management, scoring, and player interaction, allowing Dominion enthusiasts to focus on strategy and enjoyment.
Welcome to the **Unofficial Dominion Assistant**, a React application designed to enhance your gameplay experience for the popular card game, Dominion! This tool provides comprehensive features for game management, scoring, and player interaction, allowing Dominion enthusiasts to focus on strategy and enjoyment.

## Disclaimer for End Users

Expand Down Expand Up @@ -34,17 +34,16 @@ Our application, as a fan-built tool that does not replicate the game, could be
- **Expansion Support**: Compatibility with various Dominion expansions and game mats
- **Save/Load Games**: Ability to save game progress and resume later
- **Intuitive UI**: User-friendly interface with Material-UI components
- **Cross-Platform**: Works on iOS, Android, and web browsers

This is an [Expo](https://expo.dev) project created with [`create-expo-app`](https://www.npmjs.com/package/create-expo-app).
This is an [NX](https://nx.dev/getting-started/intro) project created with [`create-nx-workspace`](https://nx.dev/nx-api/nx/documents/create-nx-workspace).

## Getting Started

### Prerequisites

- Node.js (version 20.9.0 or higher)
- yarn (version 1.22.22 or higher)
- Expo CLI
- NX CLI

### Installation

Expand All @@ -68,7 +67,7 @@ From here you may follow the instructions below or jump to the section on Dev Co
yarn start
```

In the output, you'll find options to open the app in a development build, Android emulator, iOS simulator, or Expo Go.
A popup should offer to open the application in a browser.

### Visual Studio Code Dev Container Preqrequisites

Expand Down Expand Up @@ -96,20 +95,13 @@ In the output, you'll find options to open the app in a development build, Andro
yarn start
```

In the output, you'll find options to open the app in a

- [development build](https://docs.expo.dev/develop/development-builds/introduction/)
- [Android emulator](https://docs.expo.dev/workflow/android-studio-emulator/)
- [iOS simulator](https://docs.expo.dev/workflow/ios-simulator/)
- [Expo Go](https://expo.dev/go), a limited sandbox for trying out app development with Expo

You can start developing by editing the files inside the **app** directory. This project uses [file-based routing](https://docs.expo.dev/router/introduction).
A popup should offer to open the application in a browser.

### Preferred Development Environment

We highly recommend using Visual Studio Code Dev Containers/Docker for a consistent and isolated development environment. This ensures that all dependencies and configurations are standardized across different development setups.

The devcontainer.json postCreateCommand will run through setup of NVM to select a desired version of Node, perform the yarn install, and install the expo-cli globals.
The devcontainer.json postCreateCommand will run through setup of NVM to select a desired version of Node, perform the yarn install, and install the nx cli globals.

## Usage

Expand All @@ -134,14 +126,9 @@ To start a new game:

Other commands available:

- yarn start: Starts the Expo development server
- yarn android: Starts the app on Android
- yarn build:android: Builds the Android app using EAS with a preview profile
- yarn build:ios: Builds the iOS app using EAS with a preview profile
- yarn ios: Starts the app on iOS
- yarn web: Starts the app for web
- yarn start: Starts the development server
- yarn build: Builds the app using NX
- yarn test: Runs Jest tests in watch mode
- yarn lint: Runs the Expo linter
- yarn lint:eslint:fix: Runs ESLint with auto-fix option
- yarn format: Runs Prettier to format various file types

Expand Down
5 changes: 4 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,10 @@
"start": "nx serve",
"build": "nx build",
"test": "nx test",
"test:single": "npx nx test dominion-assistant --coverage=false --testPathPattern"
"test:single": "npx nx test dominion-assistant --coverage=false --testPathPattern",
"lint:eslint:fix": "eslint . --fix",
"format": "prettier --write \"**/*.{js,jsx,ts,tsx,json,md}\"",
"reset": "./reset.sh"
},
"private": true,
"dependencies": {
Expand Down
3 changes: 3 additions & 0 deletions reset.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
#!/bin/bash
rm -rf node_modules
yarn
Loading

0 comments on commit cd3cb3b

Please sign in to comment.