Update README.md

This commit is contained in:
Chigozirim Igweamaka 2024-06-26 05:21:18 +01:00 committed by GitHub
parent ffb0dca107
commit feb6417daa

View file

@ -18,19 +18,26 @@ Clone the repository:
``` ```
git clone https://github.com/cgzirim/song-recognition.git git clone https://github.com/cgzirim/song-recognition.git
``` ```
Install dependencies Install dependencies for the backend
``` ```
cd song-recognition cd song-recognition
go get ./... go get ./...
``` ```
Install dependencies for the client
```
cd song-recognition/client
npm install
```
## Usage ## Usage
Install and Start the Client App Start the Client App
``` ```
cd client
npm install
npm start npm start
``` ```
Serve the Backend App
```
go run main.go serve [-proto <http|https>] [-port <port number>]
```
Download a Song Download a Song
``` ```
go run main.go download <https://open.spotify.com/.../...> go run main.go download <https://open.spotify.com/.../...>
@ -39,10 +46,6 @@ Find matches for a song/recording
``` ```
go run main.go find <path-to-wav-file> go run main.go find <path-to-wav-file>
``` ```
Serve the Application
```
go run main.go serve [-proto <http|https>] [-port <port number>]
```
### Example ### Example
Download a song Download a song