Skip to content

MuseDevInc/muse-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

100 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Contributors Forks Stargazers Issues


Muse API

Backend API created and deployed for the Muse App
Explore the deployed app »

About The Project

Muse is an app that allows you to connect with people who have the same taste in music as you.

Frontend repo on github is found here »

(back to top)

Models

User Model

{
  username:{type:String, required:true},
  password:{type:String, required:true},
}

Profile Model

{
  owner: {
      type: mongoose.Schema.Types.ObjectId,
      ref: "User",
  },
  location: { type: String },
  aboutMe: { type: String },
  favGenres: [{ type: String }],
  favAlbum: { type: String },
  favArtist: { type: String },
  favSongs: [
      {
      title: String,
      uri: String,
      artist: String,
      albumUrl: String,
      },
  ],
  swipedRight: [{ type: String }],
  swipedLeft: [{ type: String }],
}

Conversation Model

{
  members: [{type: String}]
}

Message Model

{
  conversationId:{
      type:String,
  },
  sender:{
      type:String,
  },
  text:{type:String},

}, {timestamps:true})

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

Installation - Frontend

  1. Clone the repo

    git clone https://github.com/MuseDevInc/muse-app
  2. install modules

    npm install
  3. Create your .env variables

     PORT=<>
     MONGODB_URI=<>
     SESSION_SECRET=<>
     REDIRECT_URI=<>
     SPOTIFY_CLIENT_ID=<>
     SPOTIFY_CLIENT_SECRET=<>
    
  4. Run npm start

    // cd into the directory
    npm start

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

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)

Developers

  • Charmille Dizon
  • Christian Staubo
  • Jordan Walsh
  • Kahlil Sassa

(back to top)

Acknowledgments

(back to top)

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors