GuitAR

GuitAR is an web app which projects the chords for any song from our wide selection on to user's guitar on their screen so that all they have to do is press the highlighted strings to play the song.

final.video.mp4

Installation

Before working on frontend you will need to set up the backend. You can use our hosted backend or run your own backend for better performance. If you choose to host your own you can find it here.

Fork

Create your own copy of the project on GitHub. You can do this by clicking the Fork button on the top right corner of the landing page of the repository.

Clone

Note: For this you need to install git on your machine

$ git clone https://github.com/YOUR_GITHUB_USER_NAME/GuitAR-frontend

where YOUR_GITHUB_USER_NAME is your GitHub handle.

Set Backend Base URL

Note: Skip this step if you are using our backend.

1. Go to src/Utils/axios.js
2. Replace baseURL to your own URL.

import axios from "axios"

const instance = axios.create({
    baseURL: "YOUR_BACKEND_URL_HERE"
})

export default instance

Run the app

Now you can run GuitAR React application by following the steps below:

1. install dependencies by running the command below

$ npm install

2. run the app using the command below

$ npm start

3. go to the browser on http://localhost:3000/

ScreenShots

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

The project is licensed under the MIT License. Learn more about it in the LICENCE file.