a full MERN stack tea collection tracker
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
client
config
dist
models
routes/api
validation
.env.default
.gitignore
Procfile
README.md
package-lock.json
package.json
server.js

README.md

cuppa

A full MERN stack tea collection tracker

Cuppa is built on React with Redux, Node using Express and Mongoose, and connected to a MongoDB database. It also uses JWT tokens for authentication and user management. Scripts are built using Parcel instead of Webpack.

Table of Contents

Background

Cuppa was created to fill a personal need. I have a large variety of teas I enjoy drinking, a whole cabinet full of them. In order to keep track of what I drink, how much, when I'm running low, etc. I needed a simple app. Coincedentally, I wanted to dig deeper into React and build something full stack while I was at it. The end result is Cuppa.

Install

After downloading the repo, run npm install in both the root and client folders.

You'll need to create a MongoDB database (I used mlab.com). Once that's complete, make a copy of the .env.default file in the root, rename it .env and paste in the correct uri for your database.

Usage

To run locally, use npm run dev to launch both the server and front end apps.

API

TODO: fill in this information

Maintainers

@jenniferlynparsons

Contributing

This is a personal project, so I'm unlikely to accept PRs but you're welcome to fork the project.

Small note: If editing the README, please conform to the standard-readme specification.

License

MIT © 2019 Jennifer Lyn Parsons