tashikomaaa / d

MERN Stack Template

---

Table of Contents

• Description
• Quick Note
• Dependencies
• Installation Requirements
• Configuration
• Usage
• Development
• Supported Versions
• Contributing
• Bugs and Issues
• License

Description

mern-stack-template is a MERN Stack Template created to easily get started with developing a Full Stack Web App using the complete MERN Stack.

Getting started with this template is simple and easy. The template itself is a full backend and using a few simple commands, it will automatically install the latest version of React by using npx create-react-app client to install a React frontend.

Download

Download the zip or clone this project.

git clone https://github.com/davidsaulrodriguez/mern-stack-template.git
cd mern-stack-template/

Quick Note

This project is equiped with a basic API setup using Mongoose. It is expected that you will modify this API backend as necessary to suite your project. DO NOT count on and use the current API's USER SCHEMA as it is only meant as a placeholder and is far from a complete model.

Dependencies

Project Dependencies

• "axios": "^0.21.1",
• "concurrently": "^6.0.0",
• "dotenv": "^8.2.0",
• "express": "^4.17.1",
• "helmet": "^4.4.1",
• "if-env": "^1.0.4",
• "mongoose": "^5.12.2"

Development Dependencies

• "@babel/eslint-parser": "^7.13.10",
• "@babel/plugin-syntax-jsx": "^7.12.13",
• "@babel/preset-react": "^7.12.13",
• "@babel/runtime": "^7.13.10",
• "eslint": "^7.22.0",
• "eslint-config-prettier": "^8.1.0",
• "eslint-plugin-import": "^2.22.1",
• "eslint-plugin-jest": "^24.3.2",
• "eslint-plugin-jsx-a11y": "^6.4.1",
• "eslint-plugin-prettier": "^3.3.1",
• "eslint-plugin-react": "^7.23.1",
• "eslint-plugin-react-hooks": "^4.2.0",
• "jest": "^26.6.3",
• "nodemon": "^2.0.7",
• "prettier": "^2.2.1",
• "ts-node": "^9.1.1",
• "typescript": "^4.2.3"

Installation Requirements

You will need NodeJS installed for use with this project.

You will also need the latest version of MongoDB installed locally on your machine.

Configuration

To configure this application for use, you should create a .env file with your database information. For convience, a sample enviroment variable file can be found in the root directory with the name of: .env.example.

After installing the dependencies and initializing the project (instructions below) you will need to go into the package.json file in your client/ folder and add "proxy": "http://localhost:3001" to this file.

Usage

Getting Started

To get started with this project, you'll want to install the required dependencies and the React frontend with this command:

npm run install:all

Development

Starting the project

While working and developing on the source code, you can run a live development server (front and backend) with:

npm run start:dev:watch

To start just the backend MonogoDB server and work on the API you can run:

npm run start:server

To start just the React frontend and work on the UI, you can run:

npm run start:client

Formatting (Prettier)

It is suggested that you format your code with Prettier in order to make sure you code looks clean and consistent before you commit and publish it to GitHub. To do this, you can simply run:

This will format both your backend and frontend code with Prettier

npm run format

Linting (ESLint)

Linting is important! You can statically analyzes your code to quickly find problems with ESLint by running:

Lint check backend code

npm run lint:check

Lint check frontend code

npm run lint:check:client

Lint check backend and frontend code

npm run lint:check:all

Linting Autofix (ESLint)

This project supports ESLint autofixing to try and assist you with fixing any issues that ESLint may find in your code. To do this you can simply run:

Please keep in mind that this is not full-proof.

Lint fix backend code

npm run lint:fix

Lint fix frontend code

npm run lint:client:fix

Lint fix backend and frontend code

npm run lint:fix:all

Supported Versions

Below is a list of the currently supported versions of this software.

Note: This project is an ephemeral homework assignment and will not be worked on past its release (due date). Hence the week-long support life cycle.

Release	Status	Initial Release	Active LTS Start	Maintenance LTS Start	End of Life
develop	Unstable	-	-	-	-
v1	✔️	2021-03-25	2021-09-25	-	2022-03-25
v2	🚧	2022-03-01	2022-09-01	2023-03-01	2024-03-01

You can view the Status Key Map and software support model here.

Contributing

Contributions are more than welcome! If you improve on this project, please feel free to share it by submitting a Pull Request.

Before contributing, be sure to check out the CONTRIBUTING and Branching Model docs.

Bugs and Issues

Found a bug? Having an issue with this app? Open a new issue here.

License

This project and all of its source code is released and permissively licensed under the BSD 2 Clause license.