https://github.com/dibenso/guitar-meister

Guitar game for the web :guitar:
https://github.com/dibenso/guitar-meister

downshift eslint game guitar guitar-meister jest nextjs prettier react react-redux redux tailwindcss typescript

Last synced: about 1 month ago
JSON representation

Guitar game for the web :guitar:

• Host: GitHub
• URL: https://github.com/dibenso/guitar-meister
• Owner: dibenso
• License: mit
• Created: 2020-12-02T22:11:47.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2023-01-16T10:05:54.000Z (almost 2 years ago)
• Last Synced: 2024-04-14T06:04:42.878Z (7 months ago)
• Topics: downshift, eslint, game, guitar, guitar-meister, jest, nextjs, prettier, react, react-redux, redux, tailwindcss, typescript
• Language: TypeScript
• Homepage:
• Size: 6 MB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Guitar Meister

[![Build Status](https://travis-ci.com/dibenso/guitar-meister.svg?branch=main)](https://travis-ci.com/dibenso/guitar-meister) 

[![Coverage Status](https://coveralls.io/repos/github/dibenso/guitar-meister/badge.svg?branch=main)](https://coveralls.io/github/dibenso/guitar-meister?branch=main)       

A "Guitar Hero" like game for the web                               

## Building and running

First clone the repo and `cd` into the app:     

```sh

git clone [email protected]:dibenso/guitar-meister.git

cd guitar-meister

```

### If you want to build with [Docker](https://www.docker.com/):

```sh

docker build -t dibenso/guitar-meister:latest .

docker run -p 3000:3000 -d dibenso/guitar-meister

```

### Normal build with [Yarn](https://yarnpkg.com/):

```sh

yarn install

yarn build

yarn run

```

Once the app is running go to [http://localhost:3000](http://localhost:3000)

## Development

Running the tests:

```sh

yarn test

```

Starting the dev server:

```sh

yarn dev

```

## Contributing

1. Fork it :fork_and_knife:

2. Create your feature branch: `git checkout -b my-new-feature`

3. Commit your changes: `git commit -am 'Add some feature'`

4. Push to the branch: `git push origin my-new-feature`

5. Submit a pull request :smiley:

For more, check out [CONTRIBUTING.md](https://github.com/dibenso/guitar-meister/blob/main/CONTRIBUTING.md)