(View Raw will give you the markdown that you can copy to your repos!)
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.sql
file 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 server
in your terminal - Run
npm run client
in your terminal - The
npm run client
command 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 [email protected]