Duration: 2 Week Sprint
Directly above this is how long it took you to develop the project. Your project description goes here. What problem did you solve? How did you solve it?
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed aliquam at massa in faucibus. Etiam volutpat, risus non mollis convallis, velit nisi pulvinar mi, eu faucibus orci nisi eget nibh. Integer a velit pretium, volutpat arcu eleifend, fringilla elit. Cras erat sapien, convallis venenatis tellus vitae, feugiat dictum felis.
Suspendisse euismod volutpat aliquet. Maecenas vulputate mauris in pellentesque facilisis. Phasellus varius malesuada semper. Cras sollicitudin diam mollis maximus aliquam.
To see the fully functional site, please visit: DEPLOYED VERSION OF APP
Include one or two screen shots of your project here (optional). Remove if unused.
Link to software that is required to install the app (e.g. node).
- Node.js
- List other prerequisites here
How do you get your application up and running? This is a step by step list for how another developer could get this project up and running. The good target audience in terms of knowledge, would be a fellow Primer from another cohort being able to spin up this project. Note that you do not need a paragraph here to intro Installation. It should be step-by-step.
If your application has secret keys (for example -- Twilio), make sure you tell them how to set that up, both in getting the key and then what to call it in the .env file.
- Create a database named
your database name, - The queries in the
tables.sqlfile are set up to create all the necessary tables and populate the needed data to allow the application to run correctly. The project is built on Postgres, so you will need to make sure to have that installed. We recommend using Postico to run those queries as that was used to create the queries, - Open up your editor of choice and run an
npm install - Run
npm run serverin your terminal - Run
npm run clientin your terminal - The
npm run clientcommand will open up a new browser tab for you!
How does someone use this application? Tell a user story here.
- xxx
- xxx
- xxx
- xxx
- xxx
- xxx
List technologies and frameworks here
Note, include this only if you have a license file. GitHub will generate one for you if you want!
Thanks to Prime Digital Academy who equipped and helped me to make this application a reality. (Thank your people)
If you have suggestions or issues, please email me at youremail@whatever.com
- Branches are created from the
devbranch of the repository - Branch (story branch) names are based off of ticket id (i.e.
TTT-##) - To create a new branch:
git checkout -b <story branch>
- Pull requests are to be made after all feature development and testing scripts have been written
- PR Title is the title of the ticket (i.e. "TTT-##: Ticket Title")
- PR Comment should clearly outline the work performed on the branch
- An approver needs to be assigned and team pinged about new branch
- Branch needs to be assigned to requester
- Branches ARE NOT merged from GitHub
- Commits need to be "squashed" to keep
devclean - Branches should be deleted after PR has been approved and branch merged into
dev - Once approved, branch owner commits the branch as follows:
git checkout devgit fetch --allgit pull origin devgit merge --squash <story branch>(Resolve any merge conflicts before continuing)git commit -a -m "<story branch>: <story title>"git push origin devgit branch -D <story branch>git push origin :<story branch>
This project was bootstrapped with Create React App.
In the project directory, you can run:
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.
Launches the test runner in the interactive watch mode.
See the section about running tests for more information.
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.
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.
You can learn more in the Create React App documentation.
To learn React, check out the React documentation.
This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting
This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size
This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app
This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration
This section has moved here: https://facebook.github.io/create-react-app/docs/deployment
This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify