🚫 Note: All lines that start with 🚫 are instructions and should be deleted before this is posted to your portfolio. This is intended to be a guideline, feel free to add your own flare to it.
🚫 The numbers 1️⃣ through 5️⃣ next to each item represent the week that part of the docs needs to be comepleted by. Make sure to delete the numbers by the end of Labs.
🚫 Each student has a required minimum number of meaningful PRs each week per the rubric. Contributing to docs does NOT count as a PR to meet your weekly requirements.
1️⃣ You can find the deployed project at [🚫URL NAME GOES HERE](🚫copy and paste URL here).
🚫Add contributor info below, make sure add images and edit the social links for each member. Add to or delete these place-holders as needed
| Student 1 | Student 2 | Student 3 | Student 4 | Student 5 |
| Student 6 | :-----------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------: |
| 
|
|
|
|
|
|
|
|
|
🚫 4️⃣ Optional examples of using images with links for your tech stack, make sure to change these to fit your project
](netlify link goes in these parenthesis)
🚫 more info on using badges here
1️⃣ [Product Canvas](🚫add link to product canvas here)
1️⃣ Figma Board
🚫 Replace lorem ipsum with a description of your project
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
- feature one
- feature two
- feature three
- feature four
- feature five
🚫 Why did you choose this framework?
- point one
- point two
- point three
- point four
🚫List the rest of the front end features and libraries in the same format as the framework above.
- point one
- point two
- point three
🚫 List the rest of the back end end features and libraries in the same format as the framework above
🚫Replace text below with a description of the API
Water's like me. It's laaazy ... Boy, it always looks for the easiest way to do things A little happy sunlight shining through there. Let all these little things happen. Don't fight them. Learn to use them. Even the worst thing we can do here is good.
🚫Replace text below with a description of the API
This is the way you take out your flustrations. Get away from those little Christmas tree things we used to make in school. Isn't it fantastic that you can change your mind and create all these happy things? Everything's not great in life, but we can still find beauty in it.
🚫Replace text below with a description of the API
You can do anything your heart can imagine. In life you need colors. This is where you take out all your hostilities and frustrations. It's better than kicking the puppy dog around and all that so. I'm sort of a softy, I couldn't shoot Bambi except with a camera. Trees get lonely too, so we'll give him a little friend. We'll lay all these little funky little things in there.
🚫Replace text below with a description of the API
When you do it your way you can go anywhere you choose. Let your heart take you to wherever you want to be. If I paint something, I don't want to have to explain what it is. A tree needs to be your friend if you're going to paint him. That's a son of a gun of a cloud. Even the worst thing we can do here is good.
🚫Replace text below with a description of the API
Volunteering your time; it pays you and your whole community fantastic dividends. Maybe there's a happy little waterfall happening over here. You can spend all day playing with mountains. We don't have to be committed. We are just playing here. You have freedom here. The only guide is your heart. It's cold, but it's beautiful.
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:
🚫These are just examples, replace them with the specifics for your app
* REACT_APP_apiKey - this is your Google API key, which can be generated in the Google Cloud Console
* REACT_APP_authDomain - when you set up your Firebase project, this information will be in the dashboard
* REACT_APP_databaseURL - in the Firebase dashboard
* REACT_APP_projectID - in the Firebase dashboard
* REACT_APP_storageBucket - in the Firebase dashboard
* REACT_APP_messagingSenderId - in the Firebase dashboard
* REACT_APP_stripe_API - this is your public Stripe API key, generated in the Stripe dashboard
* REACT_APP_backendURL - optional for your local development server
* REACT_APP_clientid - this is the Stripe_connect clientID, generated in Stripe_connect settings
* REACT_APP_stripe_plan - this is the ID for a second Stripe subscription plan, generated under Stripe products
🚫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 |
|---|---|---|
| doodles.png | Nicole Bennett | Creative Commons |
| rings.svg | Sam Herbert | MIT |
🚫Document what you used for testing and why
🚫explain how to install the required dependencies to get this project up and running with yarn and NPM
🚫replace these examples with your own
* typecheck - runs the TypeScript compiler
* build - creates a build of the application
* 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.
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.