ruineto-software-engineer / sing-me-a-song

Sing me a song is an anonymous song recommendation application. The more people like a recommendation, the more likely it is to be recommended to other people using the platform!

Sing me a Song

An anonymous music recommendations app!

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. Contact
7. Acknowledgments

About The Project

This project aims to anonymously allow users to easily share and recommend music to other users.

(back to top)

Built With

In this section all the main frameworks/libraries used for the development of this project are presented.

• React.js
• Styled Components
• Axios
• Web Vitals

(back to top)

Getting Started

In this section you will know all the steps so that you can make a quick and practical installation of the project. Follow the steps that have been listed below sequentially and enjoy the work!

Prerequisites

Before starting the project installation, it is essential that some prerequisites are met, and each of them are listed below.

• npm

  npm install npm@latest -g

• postgres

  sudo apt install postgresql postgresql-contrib

Installation

Follow the steps listed below to correctly install and configure the application in a simple and practical way. If there is an error in the installation or if any of the steps listed below is not done, you are not sure that the project will work on your machine, follow the steps, if you have any questions about this step, contact us.

1. Clone the repo

   git clone [e-mail]:ruineto-dev/sing-me-a-song.git

2. Install NPM packages

   npm install

3. Enter your BASE URL in .env

   REACT_APP_API_BASE_URL=http://localhost:5000

   (back to top)

Usage

To start using the project, just follow the steps that were presented along the Roadmap, listed below. Soon some photos/images/videos of usability examples of the project will be posted here.

(back to top)

Roadmap

• Clone the project
• Open the project with an IDE/code editor
• Install project dependencies
• Create a new branch with your new feature
  • Access the new feature
  • Push the new modifications
• Add a pull request
• Wait for the evaluation (around 1 day)

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Every contribution is always welcome from all developers. Contributing and sharing knowledge is what makes the world a diverse and exciting place, so if you have a suggestion, please share it. If you want to share a suggestion, fork the repository and create a pull request. If you feel comfortable, open an issue with the tag "enhancement". Help spread the word about this incredible work by giving the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingNewFeature)
3. Commit your Changes (git commit -m 'Add some AmazingNewFeature')
4. Push to the Branch (git push origin feature/AmazingNewFeature)
5. Open a Pull Request

(back to top)

License

Distributed under a FREE license. Consult the developer for more information.

(back to top)

Contact

Rui Neto - @ruineto-dev - [e-mail]
Project Link: @sing-me-a-song

(back to top)

Acknowledgments

I would like to express my sincere thanks to the team and the teams that set out to develop these excellent technologies that were essential for the creation of this project.

• Cypress
• ESlint
• Prettier

(back to top)