DJ Helper

...

You can find the deployed project here.

Contributors

Heather Nuffer	Dan Johnson	Andrew Garcia	Phil MacEachron	Humaira Syed

Stephanie Miller	Emily Arias	Mariana Dominguez	Jordan Heuer	Isaac Lopez

Project Overview

Trello Board

Product Canvas

UX Design files

Mission Statement: To be the easiest way for DJs to collect and display relevant song requests at events.

Key Features

• DJs can create accounts.

• DJs can sign in to their accounts.

• DJs can add additional profile information: their website, phone, bio, and link to their profile image.

• DJs can edit their profile information.

• DJs can delete their accounts.

• DJs can see their dashboards.

• DJs can create events.

• DJs can edit events.

• DJs can delete events.

• DJs can search for songs to add to playlists.

Tech Stack

Front end built using: React.

Packages used for styling: bootstrap, reactstrap, node-sass, react-loader-spinner, @fortawesome/fontawesome-svg-core, @fortawesome/free-brands-svg-icons, @fortawesome/free-regular-svg-icons, @fortawesome/free-solid-svg-icons, @fortawesome/react-fontawesome.

Packages used for state management: redux, react-redux, redux-thunk.

Packages used for testing: @testing-library/jest-dom, @testing-library/react, @testing-library/user-event.

Packages used for development (linters): eslint, eslint-config-airbnb, eslint-config-node, eslint-config-prettier, eslint-plugin-import, eslint-plugin-jsx-ally, eslint-plugin-node, eslint-plugin-prettier, eslint-plugin-react, eslint-plugin-react-hooks, prettier.

Front end deployed to AWS at dj-helper.com.

Back end built using: Node.JS, Express, Postgresql, AWS

Packages for authentication: jsonwebtoken, bcryptjs

Packages for database setup/management: knex, knex-cleaner, pg

Packages for security: cors, dotenv, fs, helmet, https

Packages for server setup/management: express, morgan

Environment Variables

In order for the app to function correctly, the user must set up their own environment variables. There should be a .env file containing the following:

*  REACT_APP_BACKEND_HOST - this is "http://localhost:8000" if running locally, OR the back end deployed url if using the deployed back end: "https://api.dj-helper.com/"

* REACT_APP_FRONTEND_HOST = 'http://localhost:3000/'  - if running locally, with whichever port you are using for the front end.

* CI=true - this is needed to run the test coverage reports for Code Climate

* REACT_APP_SPOTIFY_CLIENT_ID - you can get this by registering for the Spotify API

Testing

Testing is done using the @testing-library/jest-dom, @testing-library/react, and @testing-library/user-event packages. Tests are located in the src/tests directory. Tests are grouped into files by component.

Our UX team member also runs surveys and user tests. Her results can be found here.

Installation Instructions

To get the app running locally:

1. Clone this repo

2. npm i to install all required dependencies

3. npm start to start the local server and run the app in the development mode.

4. 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.

5. If you want to use localhost for your back end, see the back end documentation for instructions on setting that up.

Other Scripts

• 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.

• 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.

• test - Launches the test runner in the interactive watch mode.

  • See the section about running tests for more information.

• eject - Copies the configuration files and dependencies into the project so you have full control over them

  • 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.

• coverage - Runs a coverage test and report.

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Please note we have a code of conduct. Please follow it in all your interactions with the project.

Issue/Bug Request

If you are having an issue with the existing project code, please submit a bug report under the following guidelines:

• Check first to see if your issue has already been reported.
• Check to see if the issue has recently been fixed by attempting to reproduce the issue using the latest master branch in the repository.
• Create a live example of the problem.
• Submit a detailed bug report including your environment & browser, steps to reproduce the issue, actual and expected outcomes, where you believe the issue is originating from, and any potential solutions you have considered.

Feature Requests

We would love to hear from you about new features which would improve this app and further the aims of our project. Please provide as much detail and information as possible to show us why you think your new feature should be implemented.

Pull Requests

If you have developed a patch, bug fix, or new feature that would improve this app, please submit a pull request. It is best to communicate your ideas with the developers first before investing a great deal of time into a pull request to ensure that it will mesh smoothly with the project.

Remember that this project is licensed under the MIT license, and by submitting a pull request, you agree that your work will be, too.

Pull Request Guidelines

• Ensure any install or build dependencies are removed before the end of the layer when doing a build.
• Update the README.md with details of changes to the interface, including new plist variables, exposed ports, useful file locations and container parameters.
• Ensure that your code conforms to our existing code conventions and test coverage.
• Include the relevant issue number, if applicable.
• You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.

Attribution

These contribution guidelines have been adapted from this good-Contributing.md-template.

Documentation

See Backend Documentation for details on the backend of our project.