Git Product home page Git Product logo

ensemble's Introduction

LinkedIn License


Ensemble

Review albums/songs and share with your friends!
View Demo · Report Bug · Request Feature

Table of Contents
  1. About Ensemble
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

Ensemble Screen Shot

As someone who listens to a ton of music, I've always wanted a platform to share my opinions with my friends in an easy way. Thus, I decided to started building this app! It allows users to create reviews for albums, choose their top songs and see listening info based on their Spotify Account. I used Typescript in React, Node, Express, and MongoDB to create this app. Please let me know what you think!

(back to top)

Built With

  • React
  • Node
  • Express
  • MUI
  • React Router
  • MongoDB
  • MongoDB

(back to top)

Getting Started

This is how you get Ensemble running locally. To get a local copy up and running follow these steps:

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

  • npm
    npm install npm@latest -g
  • MongoDB - sign up for account, and provide connection link in .env file under DATABASE_URL

Installation

  1. Clone the repo

    git clone https://github.com/ramjayakumar21/Ensemble.git
  2. Run the build script (installs NPM packages)

    source build.sh
  3. Run the start script

    source start.sh

The frontend should run on your localhost on port 5173.

Usage

Users can sign up and sign into accounts via the accounts page, which uses Firebase to store user data. Once they have linked their Spotify, they can then create userreviews.

(back to top)

Roadmap

  • Support creating review objects and database storage
  • Support user sign up and linking to Spotify API
  • Support comments and public accounts
    • Add attribute to show if account/review is public/private

Future plans include supporting a user search bar, listen-along section, group reviews, and timestamp highlighting.

(back to top)

Contributing

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

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

(back to top)

Credits

This README was built from a template taken from here.

(back to top)

Contact

Ram Jayakumar - Linkedin - [email protected]

Project Link: https://github.com/ramjayakumar21/Ensemble

(back to top)

ensemble's People

Contributors

ramjayakumar21 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.