CoLAB

CoLAB Project, 8-5-2021

By Harrison Strand

Navigate to the live site

https://colab-mern.netlify.app/

Description

This project is designed as a collaborative social media app for musicians. Users have the ability to create a profile with specific musical interests, gear, and workflow style and find other similar musicians to collaborate with based on their posts, as well as leave comments and react with other user posts.

User Stories

Expand

ID	User Story	Accepted
US01	"As a user, I want to be able to log in and view/edit my profile"	True
US02	"As a user, I want to be able to log in and view a feed of posts from other musicians"	True
US03	"As a user, I want to be able to create a post in the home feed"	True
US04	"As a user, I want to be able to add reactions to other musician posts"	True
US05	"As a user, I want to be able to message other musicians after seeing their posts"	True
US06	"As a user, I want to be able to click on a profile name to see that specific user's interests"	True
US07	"As a user, I want to be able to upload photos to posts and as my profile picture"	True
US08	"As a user, I want to be able to upload embedded audio files so that other user's can get an idea of what I'm creating"	True
US09	"As a user, I want to be able to leave a comment on a user's post"	True
US10	"As a user, I want to be able to get posts recommended to me based on tags and preferences"	True

Setup/Installation Requirements

Software Requirements

1. Internet browser
2. A code editor such as VSCode to view and edit the code

Open Locally

• Click on the link to my repository: My Repository
• Click on the green "Code" button and copy the repository URL
• Open your terminal and use the command git clone into the directory you would like to clone the repository
• Open in text editor to view code and make changes

Getting Started with Create React App

This project was bootstrapped with Create React App.

Required Scripts

In the project directory, run:

npm install

Installs all dependancies for the project in order to run the application

npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

Database and Deployment Requirements

To use database and deployment functionality, first create your personal atlas cluster at mongodb.com, a new app at heroku.com, and a new site for the project at netlify.com

1. create a .env file in the main project directory
2. use the .env.example as a guide and replace MONGO URL STRING HERE with your CONNECTION URL from MongoDB.
3. after creating your new app in Heroku, login to Heroku in the console and use git to commit and add changes from the backend to the heroku remote.
4. after running npm build in the client side directory of this project, find the newly created build directory and drag folder to the deployment section of your netlify application.

Available Scripts

npm test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

npm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

npm run eject

Note: this is a one-way operation. Once you eject, you can’t go back!

If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.

You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.

Learn More

Expand

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.

Code Splitting

This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting

Analyzing the Bundle Size

This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size

Making a Progressive Web App

This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app

Advanced Configuration

This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration

Deployment

This section has moved here: https://facebook.github.io/create-react-app/docs/deployment

npm run build fails to minify

This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify

Known Bugs

Upcoming Edits

• Create functionality for viewing other user profiles through posts
• Ability to upload profile pictures and project links
• Embed audio files into posts
• Ability to create full profile with preferences

Support and Contact Details

If any further errors or bugs occur with installation, please email me, [email protected].

Technologies Used

• Node
• MongoDB
• Heroku
• Netlify
• React
• Redux
• Thunk
• Express
• OAuth
• Axios
• bcrypt
• MaterialUI
• react-filebase64
• jwt-decode
• react-google-login

License

This software is licensed under the MIT License.

Copyright (c) 2021 Harrison Strand