Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
abohannon authored Feb 12, 2018
1 parent 8cd2145 commit 6cfd2f3
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
# Ticket Mailer
> Custom Shopify app designed for SHOWstubs.com
Ticket Mailer is a custom MERN app designed specifically for SHOWstubs.com to send VIP concert tickets to customers after they purchase their VIP ticket bundles.
Ticket Mailer is a custom MERN stack app designed specifically for SHOWstubs.com to send VIP concert tickets to customers after purchasing their VIP ticket bundles.

The primary stack for this app is React, Node, Express, and MongoDB.

The app is built with React, Node, mongoDB, mongoose, express

## Installing / Getting started

Expand All @@ -16,6 +17,7 @@ npm run dev

The above command will start the Node server as well as start react-scripts and launch the app on localhost:3000.


## Developing

To install:
Expand All @@ -42,9 +44,9 @@ module.exports = {
```
Relevant links:

Shopify App Developer Program (https://developers.shopify.com/)
mLab (https://mlab.com/)
Mailgun (https://www.mailgun.com/)
* Shopify App Developer Program - https://developers.shopify.com/
* mLab - https://mlab.com/
* Mailgun - https://www.mailgun.com/

### Building

Expand All @@ -58,7 +60,7 @@ React build script will run and save assets in the client/build directory.

### Testing

To start the test, run the following command:
To start the tests, run the following command:

```shell
cd server
Expand All @@ -78,18 +80,16 @@ their inputs before sending to all customers who ordered that particular bundle.
* An order page exists that shows all orders regardless of show date, variant, etc. User can use the search on this page to find a particular customer or order # and click through to the relevant show date and bundle page for that customer
* User can login and logout and remain authenticated while their cookie is valid.


## Future Considerations


## Contributing

If you find this project helpful as a starting point for your own project, please feel free to clone. If you are interested in submitting improvements, PRs are welcome!

## Links

Even though this information can be found inside the project on machine-readable
format like in a .json file, it's good to include a summary of most useful
links to humans using your project. You can include links like:
## Links

- Repository: https://github.com/abohannon/ticket-mailer
- Issue tracker: https://github.com/abohannon/ticket-mailer/issues
Expand Down

0 comments on commit 6cfd2f3

Please sign in to comment.