Skip to content
This repository has been archived by the owner on Feb 17, 2023. It is now read-only.
/ CookingTheBooks Public archive

A proof-of-concept implementation of the MERN stack hosted on Azure and MongoDB Atlas

License

Notifications You must be signed in to change notification settings

RyanHiller/CookingTheBooks

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

56 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Cooking The Books

node npm License: MIT standard-readme compliant

Cooking The Books is a web application developed with the MERN stack with the purpose of providing people with a quick, reliable source of recipes based on the ingredients that they have available. No saving and updating your inventory. No nonsense.

Install

This project uses Node.js, npm, MongoDB, React, and is configured to deploy to Azure. After cloning the repository, run npm install in both the root directory, as well as the /client directory to ensure all dependencies are installed.

After installation, create an environment variable DB_CONN containing the MongoDB connection link. For more information on doing this, check this link. This is currently set to work with MongoDB Atlas, however the Mongoose connection in the /server/db-conn.js file can be configured for other platforms. This project assumes a collection recipes exists already in the database, but this can be configured in the Mongoose Recipe model definition.

Usage

After dependency installation and database connection configuration is complete, simply running node server.js to run the Express server. This will launch at localhost:3001 and will output confirmation on server startup and successful database connection.

The /client directory contains the front end React application. Run npm start from this location to start the create-react-app development environment.

Contributing

Pull requests will be accepted after May 31, 2020.

Contributors

This project is the work of John Afana, Ryan Hiller, and Daniel Reuter for the Spring 2020 Technical Software Project class at MSU Denver.

License

MIT © Cooking The Books

About

A proof-of-concept implementation of the MERN stack hosted on Azure and MongoDB Atlas

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published