PLEASE READ THIS TO COMPLETION BEFORE ASKING ANY QUESTIONS!
IMPORTANT NOTES -
This project does not have a mongoDB connection setup.
local development: create a .env file (make sure to name it .env), which exports your MONGO_URL connection. This file will be ignored by git so your db credentials will be kept safe when the app is deployed.
Getting Started
This repository aims to assist you in beginning work on a MERN stack application for deployment with a solid file structure as a foundation.
Since this project will hold both the client application and the server application there will be node modules in two different places. First run npm install from the root.
yarn workspace server build
Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.
See the section about deployment for more information.
File structure
client - Holds the client application
public - This holds all of our static files
src
services - Holds all of our services
App.jsx - This is what renders the primary MERN app, should not change
index.js - This is what renders all of our browser routes
package.json - Defines npm behaviors and packages for the client
package-lock.json - Generated from above package.json
README - Getting Started with Create React App
server - Holds the server application
.env - This holds our configuration files, like mongoDB uri
models - This holds all of our data models
routes - This holds all of our HTTP to URL path associations for each unique url
db.js - Establishes the database connection with MongoDB
index.js - Defines npm behaviors and packages for the client
package.json - Defines npm behaviors like the scripts
package-lock.json - Generated from above package.json
.gitignore - Tells git which files to ignore
README - This file!
Learn More
To learn how to setup a local MongoDB instance for testing, check out how to connect to MongoDB.