Music Lab

Make a tune, or don't. It's up to you.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

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

About The Project

Simple app to make music to share with a community of people interested in the same thing.

Our Idea

To create a music app that would allow users to create songs that they could share with others through our app. Anyone can view a song but a visitor must be logged in to be able to comment on a song. Songs are saved in a users account for reference.

A list of commonly used resources that I find helpful are listed in the acknowledgements.

Built With

• Bootstrap
• FontAwesome
• MySQL
• Sequelize

Getting Started

There are a few important steps in getting this project setup. Follow the instructions

Installation

1. Clone the repo

   git clone https://github.com/drewole/music-lab-gp.git

2. Install NPM packages

   npm install

3. Enter your local MySql information in .env.example

    DB_HOST=localhost
    DB_NAME=music_lab
    DB_USER=your_username
    DB_PASSWORD=your_password
   
    SESSION_SECRET=your_secret_phrase
   

4. Seed the DB

   node seeds/index.js

5. Run the Application

   npm start

6. View the application: View in Browser

Usage

Visit the site, sign up and make some music. If you would like to contribute please contact us.

For more examples, please refer to the Documentation

Roadmap

Planned Features:

• Ability to delete and edit songs
• Additional sets of default sounds
• Song rating system
• Make it so users can record sounds to be used within the app, and share those sounds with the community.
• Add song artwork functionality
• Ability to download their own songs as a file to the machine for publish wherever
• Song categorization and tags for enhanced search

Contributing

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

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

License

Distributed under the MIT License. See LICENSE for more information.

Contact the Contributors

Drew Olsen - @drewole Levi Schwartzberg - @levischwartz Luke Paschka - @drewole

Project Link: https://github.com/drewole/music-lab-gp

Acknowledgements

• Choose an Open Source License
• Font Awesome
• Bootstrap