You can find the deployed project at https://www.voicer-app.com
#Badges
Joseph Oliver
Brian Hague
David Francis
Tim Jeffries
Christopher Quinn
Trello Board: https://trello.com/b/bSVcWjZF/voicer
Notion documentation: https://www.notion.so/Voicer-3276d8fdf5df414299411e3e393167cd
To create a voice over marketplace environment where users can post jobs, connect with reliable voice-over talent, offer a file delivery service between project owners and talent, and facilitate the financial transactions between the two parties.
- Users can create unique profiles that showcase their creative talent.
- Users can upload audio samples, and assign tags to individual audio samples to enhance searchability
- Users can post jobs and "hire" individuals that have applied
- Users can browse user profile snapshots, listening to audio samples in a Twitter-like format
The Voicer-App tech stack is as follows:
- React for front-end framework
- MaterialUI for styling/css
- @testing-library/react for unit testing
- Postgres for the database
- Heroku for backend deployment
- Netlify for frontend deployment
- AWS for asset storage (audio files)
React is a well supported, fully featured front end framework. We use Context for state management (instead of redux) since our global state schema is relatively simple (i.e.we think using redux for this application would be overkill).
We started the project using Node Sass and Bootstrap, but will merge/migrate to MaterialUI in the near future.
- We use axios for API calls. The framework is lightweight and simple, and meets all current needs of the project.
Back end built using:
- Postgres for database
- Heroku for backend deployment
- AWS for storage of audio samples
The authentication API is a gatekeeper function that is embedded in Provider.DataContext. We check if there's a token, and whether that token is still valid. While the token is valid, users remain logged in. When a user logs out or the token is deleted, the token is deleted.
There is currently no payments API for Voicer-App.
We use an API for "random" image generation on the Jobs/Marketplace component (mostly to make advertised jobs a bit more visually appealing.) Documentation for the API can be found at: https://picsum.photos
🚫For all content - images, icons, etc, use this table to document permission of use. Remove the two placeholders and add you content to this table
| Image Filename | Source / Creator | License |
|---|
| rings.svg | Material Icons | MIT |
We use @testing-library/react for unit testing. This library had the advantage of working tightly with React and not needing additional setup.
We expect a minimum threshold of 30% for test coverage.
To install the required directories for this project:
- Clone the master branch to your local device
- CD into
/voicer-client - From the terminal, run
npm ioryarn install
* start - starts the production server after a build is created
* test - runs tests in **tests** directory \* eject - copy the configuration files and dependencies into the project so you have full control over them
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. The best way to make a suggestion is to contribute to the Trello Board.
Please note we have a code of conduct. Please follow it in all your interactions with the project.
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.
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.
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.
- 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.
These contribution guidelines have been adapted from this good-Contributing.md-template.
See Backend Documentation for details on the backend of our project.