Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/laurapuerto82/song-lyrics-web

A web application that allows users to search for song lyrics by entering the artist's name and song title. Utilizes the Lyrics.ovh API to retrieve and display lyrics.
https://github.com/laurapuerto82/song-lyrics-web

api backend ejs express frontend nodejs web-development

Last synced: 21 days ago
JSON representation

A web application that allows users to search for song lyrics by entering the artist's name and song title. Utilizes the Lyrics.ovh API to retrieve and display lyrics.

Awesome Lists containing this project

README

        

# Song Lyrics Web

A web application that allows users to search for and view song lyrics. The application uses the [Lyrics.ovh API](https://lyricsovh.docs.apiary.io/#) to provide accurate and up-to-date lyrics. Users can search for songs and view the lyrics of their favorite tracks.

## Features

- Search for song lyrics by title and artist
- Display song lyrics in a clean and user-friendly interface

## Technologies Used

- **EJS**: Embedded JavaScript templating
- **Node.js**: JavaScript runtime environment
- **Express**: Web framework for Node.js
- **Lyrics.ovh API**: API for retrieving song lyrics

## Getting Started

Follow these instructions to set up and run the project locally on your machine.

### Prerequisites

Make sure you have the following software installed:

- [Node.js](https://nodejs.org/) (v14.x or higher)
- [Git](https://git-scm.com/)

### Installation

1. **Clone the repository:**

```bash
git clone https://github.com/LauraPuerto82/song-lyrics-web.git
```

2. **Navigate to the project directory:**

```bash
cd song-lyrics-web
```

3. **Install dependencies:**

```bash
npm install
```

### Running the Application

1. **Start the development server:**

```bash
npm start
```

2. **Open your browser and visit:**

```
http://localhost:3000
```

The application should now be running, and you can search for song lyrics.

### Project Structure

- `views/`: Contains EJS templates for rendering the web pages.
- `public/`: Contains static files such as CSS and images.
- `routes/`: Defines the routes for the application.
- `app.js`: Main application file.

### Contributing

If you would like to contribute to this project, please follow these steps:

1. Fork the repository
2. Create a new branch (`git checkout -b feature-branch`)
3. Make your changes
4. Commit your changes (`git commit -m 'Add some feature'`)
5. Push to the branch (`git push origin feature-branch`)
6. Open a pull request

### License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

### Acknowledgments

- [Lyrics.ovh API](https://lyricsovh.docs.apiary.io/#) for providing the song lyrics data.

---

If you have any questions or issues, feel free to open an issue in the repository or contact me at [email protected]