No Strings Attached

A Social Media app that connects you with other musicians in your area.

Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. License
5. Contact

About The Project

This social media app is designed to connect you to local musicians in your area for casual jam sessions.

Create an account with a profile picture. Then add a bio and some instruments you play.

Filter all users by area and instrument played. Add some friends and leave them a message.

(back to top)

Built With

• MERN Stack
• MongoDB
• Express.js
• React.js
• Node.js
• Redux

(back to top)

Getting Started

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

Prerequisites

• npm

  npm install npm@latest -g

Installation

1. Clone the repo

   git clone https://github.com/joewhocodes/no-strings-attached.git

2. Install Server && Client NPM packages

   cd client && npm install && cd .. && npm install

3. Add Environment variables in an .env file in root directory, including MongoDB, JWT and Cloudinary

   PORT, MONGO_URI, JWT_SECRET, CLOUD_NAME, API_KEY, API_SECRET

4. Run the app

   npm run dev

(back to top)

Usage

Create an account with the Sign Up page. The app will add the user to MongoDB including a hashed password, and your image will be added to cloudinary with a reference in MongoDB.

Go to the profile page and add a bio and some instruments.

Go to the All Users page and find some users close to you with the location filter. Use the instrument filter to find users that play the instruments your jam is missing!

Add some friends, and leave them a comment.

(back to top)

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

(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)

License

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

(back to top)

Contact

Joe Ulyatt - @joewhocodes - [email protected]

Project Link: https://github.com/joewhocodes/no-strings-attached

(back to top)