A turn-based strategy video game in which the player assumes the role of a drug dealer engaged in arbitrage. Inspired by the by the DOS game by John E. Dell in 1984. Built for the web using React and Typescript.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
Preferred node version v18.16.0 - change version with nvm
Get a development env running
# 1. Clone the repository to your local development environment
git clone https://github.com/jeffdiers/drugwars.git
# 2. Move into the project directory
cd drugwars
# 3. Install code dependencies
yarn install
# 4. Authenticate the xata CLI to your account
xata auth login
# 5. Add env vars to .env and generate file to connect to the database
xata init
# 6. Spin up a local development server
yarn start:netlify
You can now view the site in the browser at http://localhost:8888/
If using vscode I recommend installing this extension vscode-jest
or run from CLI
# Run all test suites
yarn test --watchAll
Deploy your own version of this site by selecting the Deploy to Netlify Button below. This will automatically:
- Clone a copy of this repo to your own GitHub account
- Create a new project in your Netlify account, linked to your new repo
- Create an automated deployment pipeline to watch for changes on your repo
- Build and deploy your new site
- TypeScript - The language used
- React - The web framework used
- Redux toolkit - State managment
- Xata - The database used
- Netlify - Used for CI/CD deployments
- Jest - Testing library
- Styled components - Used to style components
Please read workflow.md for details on releases.
We use SemVer for versioning. For the versions available, see the tags on this repository.
- Jeff Diers - website
This project is licensed under the MIT License - see the LICENSE.md file for details