Reflection

Reflection is a simple app which allows users to submit feedback to an admin.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

What things you need to install the software and how to install them

Basic understanding Webpack, Gulp, or Grunt
Intro to JSX
Installation of React
PostreSQL and/or Postico for Database usage

Installing

A step by step series of examples that tell you how to get a development env running

fork and clone/download this repo to your computer

npm install
npm start server

Then press Cmd + t to open a new tab in Terminal

npm start client

Using Postico, create a new database by running the queries provided

Have fun!

Deployment

Heroku Prerequisite (one time)

Sign up for an account on Heroku.com
Install Heroku CLI by typing brew install heroku in Terminal
Authenticate by typing heroku login in Terminal

Note: Your project also needs to have a git repository.

Heroku Setup

Run the following commands from within your project folder.

In terminal, navigate to your project folder and type heroku create
Login in if prompted
Type git remote -v to ensure it added successfully

Make sure your PORT is configured correctly as:

var port = process.env.PORT || 5000;

Next, commit your changes and push them to Heroku:

git add .
git commit -m "MESSAGE"
git push heroku master

Note: You'll need to commit and push each time you make a change that you want to deploy to Heroku. Keep in mind you CAN NOT pull from Heroku. This is not a replacement for GitHub!

Lastly, open terminal and type heroku open as a shortcut to open your website in a browser.

Note: It is best to fully test your code locally before deploying to Heroku. Bugs are much harder to troubleshoot on a live website.

Miscellaneous

heroku logs - Display error logs
heroku config - Show basic app info
heroku restart - Sometimes it helps to turn things off an on again
heroku open - Opens the website for you project in the browser

Resources

More detailed instructions can be found here:

https://devcenter.heroku.com/articles/git

Built With

React - A JavaScript library for building user interfaces
Axios - A Promise-based HTTP client for JavaScript
Express - Framework for Node.js
PostgreSQL - Open source object-relational databse
Node.js - JavaScript runtime
Nodemon - Utility which monitors any changes to the source and automatically restarts your server

TODO

In the future, I will be adding:

[] styling using Material-UI [] ability to flag feedback for further review by admin [] user authentication

Authors

Johnny Packard - Initial work - Johnny Packard

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

Prime Digital Academy and all its staff.
Mary Mosman for her continued guidance.
The Menkar cohort for all their assistance.

johnnypackard/reflection