CodeOne45 / discover-mesic

A platform to discover and introduce unknown artists and music.

Discover Me'sic

A platform to discover and introduce unknown artists and music.

View Demo · Documentation · Report Bug · Request Feature

📔 Table of Contents

• About the Project
  • Screenshots
  • Tech Stack
  • Features
  • Environment Variables
• Getting Started
  • Prerequisites
  • Installation
  • Running Tests
  • Run Locally
  • Deployment
• Roadmap
• Contributing
  • Code of Conduct
• FAQ
• License
• Contact
• Acknowledgements

🌟 About the Project

A platform to discover and introduce unknown artists and music.

Based on the youtube player, Discover Me'sic allows you to add unknown music with a youtube link and also to listen to the music in order to discover new artists who are not mainstream.

📷 Screenshots

👾 Tech Stack

Client

• Next.js
• React.js

Server

• Express.js

Database

• MongoDB

DevOps

• Docker

🎯 Features

• Add a song with Youtube URL (less than 50k views)
• Listen to known songs randomly
• Export your unknown artist playlist to your favorite streaming platforms

🎨 Color Reference

| Design (Figma) |

Discover Me'sic UI Mockup

🔑 Environment Variables

To run this project, you will need to add the following environment variables to your .env file

MONGODB_URI

YOUTUBE_VIEW_API YOUTUBE_VIEW_API_KEY YOUTUBE_VIEW_API_HOST

MONGO_USERNAME MONGO_PASSWORD NEXT_PUBLIC_API_URL

CLOUD_NAME CLOUD_API_KEY CLOUD_API_SECRET

SENDGRID_API_KEY FROM_EMAIL

CLIENT_ID CLIENT_SECRET

🧰 Getting Started

‼️ Prerequisites

This project uses Yarn as package manager but the app is also docorized

 npm install --global yarn

or

 docker-compose build

⚙️ Installation - Next.js App

Install app with npm

  yarn install app
  cd app

🧪 Running Tests

To run tests, run the following command

  yarn test test

🏃 Run Locally

Clone the project

  git clone https://github.com/CodeOne45/discover-mesic.git

Go to the project directory

  cd app

Install dependencies

  yarn install

Start the server

  yarn start

🚩 Deployment

To deploy this project run

  yarn deploy

🧭 Roadmap

Roadmap

👋 Contributing

Contributions are always welcome!

See contributing.md for ways to get started.

📜 Code of Conduct

Please read the Code of Conduct

❔ FAQ

NaN

⚠️ License

Distributed under the no License. See LICENSE.txt for more information.

🤝 Contact

Project Link: https://github.com/CodeOne45/discover-mesic

Notion Roadmap : Roadmap

Website: www.discovermesic.live