{"id":21180906,"url":"https://github.com/davidsaulrodriguez/mern-stack-template","last_synced_at":"2025-07-10T00:30:55.770Z","repository":{"id":43893350,"uuid":"351629810","full_name":"davidsaulrodriguez/mern-stack-template","owner":"davidsaulrodriguez","description":"A MERN Stack Template created to easily get started with developing a Full Stack Web App using the complete MERN Stack","archived":false,"fork":false,"pushed_at":"2023-07-19T01:54:46.000Z","size":987,"stargazers_count":12,"open_issues_count":3,"forks_count":3,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-05T08:34:52.446Z","etag":null,"topics":["babel","backend","dotenv","eslint","frontend","mern","mern-stack","mern-stack-template","mongodb","mongoose","prettier","react","semver","template"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-2-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/davidsaulrodriguez.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"davidsaulrodriguez"}},"created_at":"2021-03-26T01:48:12.000Z","updated_at":"2024-05-30T13:00:14.000Z","dependencies_parsed_at":"2024-11-20T22:35:16.369Z","dependency_job_id":null,"html_url":"https://github.com/davidsaulrodriguez/mern-stack-template","commit_stats":null,"previous_names":[],"tags_count":5,"template":true,"template_full_name":null,"purl":"pkg:github/davidsaulrodriguez/mern-stack-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/davidsaulrodriguez%2Fmern-stack-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/davidsaulrodriguez%2Fmern-stack-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/davidsaulrodriguez%2Fmern-stack-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/davidsaulrodriguez%2Fmern-stack-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/davidsaulrodriguez","download_url":"https://codeload.github.com/davidsaulrodriguez/mern-stack-template/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/davidsaulrodriguez%2Fmern-stack-template/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264506210,"owners_count":23619001,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["babel","backend","dotenv","eslint","frontend","mern","mern-stack","mern-stack-template","mongodb","mongoose","prettier","react","semver","template"],"created_at":"2024-11-20T17:46:33.996Z","updated_at":"2025-07-10T00:30:55.471Z","avatar_url":"https://github.com/davidsaulrodriguez.png","language":"JavaScript","funding_links":["https://github.com/sponsors/davidsaulrodriguez"],"categories":[],"sub_categories":[],"readme":"# MERN Stack Template\n\n\u003cspan align=\"center\"\u003e\n\n![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/davidsaulrodriguez/mern-stack-template)\n[![Build Status](https://travis-ci.com/davidsaulrodriguez/mern-stack-template.svg?branch=main)](https://travis-ci.com/davidsaulrodriguez/mern-stack-template)\n[![GitHub license](https://img.shields.io/github/license/davidsaulrodriguez/mern-stack-template)](https://github.com/davidsaulrodriguez/mern-stack-template)\n\n---\n\n[![GitHub issues](https://img.shields.io/github/issues/davidsaulrodriguez/mern-stack-template)](https://github.com/davidsaulrodriguez/mern-stack-template/issues)\n[![GitHub forks](https://img.shields.io/github/forks/davidsaulrodriguez/mern-stack-template)](https://github.com/davidsaulrodriguez/mern-stack-template/network)\n[![GitHub stars](https://img.shields.io/github/stars/davidsaulrodriguez/mern-stack-template)](https://github.com/davidsaulrodriguez/mern-stack-template/stargazers)\n![GitHub contributors](https://img.shields.io/github/contributors/davidsaulrodriguez/mern-stack-template)\n[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=davidsaulrodriguez_mern-stack-template\u0026metric=bugs)](https://sonarcloud.io/dashboard?id=davidsaulrodriguez_mern-stack-template)\n[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=davidsaulrodriguez_mern-stack-template\u0026metric=sqale_rating)](https://sonarcloud.io/dashboard?id=davidsaulrodriguez_mern-stack-template)\n[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=davidsaulrodriguez_mern-stack-template\u0026metric=security_rating)](https://sonarcloud.io/dashboard?id=davidsaulrodriguez_mern-stack-template)\n[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=davidsaulrodriguez_mern-stack-template\u0026metric=vulnerabilities)](https://sonarcloud.io/dashboard?id=davidsaulrodriguez_mern-stack-template)\n![GitHub commits since latest release (by SemVer)](https://img.shields.io/github/commits-since/davidsaulrodriguez/mern-stack-template/latest/main)\n\n\u003c/span\u003e\n\nTable of Contents\n\n- [Description](#description)\n- [Quick Note](#quick-note)\n- [Dependencies](#dependdencies)\n- [Installation Requirements](#installation-requirements)\n- [Configuration](#configuration)\n- [Usage](#usage)\n- [Development](#development)\n- [Supported Versions](#supported-versions)\n- [Contributing](#contributing)\n- [Bugs and Issues](#bugs-and-issues)\n- [License](#license)\n\n## Description\n\n**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.\n\nGetting 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.\n\n**Download**\n\n[Download the zip][archive] or clone this project.\n\n```shell\ngit clone https://github.com/davidsaulrodriguez/mern-stack-template.git\ncd mern-stack-template/\n```\n\n## Quick Note\n\nThis 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.\n\n## Dependencies\n\n**Project Dependencies**\n\n- \"axios\": \"^0.21.1\",\n- \"concurrently\": \"^6.0.0\",\n- \"dotenv\": \"^8.2.0\",\n- \"express\": \"^4.17.1\",\n- \"helmet\": \"^4.4.1\",\n- \"if-env\": \"^1.0.4\",\n- \"mongoose\": \"^5.12.2\"\n\n**Development Dependencies**\n\n- \"@babel/eslint-parser\": \"^7.13.10\",\n- \"@babel/plugin-syntax-jsx\": \"^7.12.13\",\n- \"@babel/preset-react\": \"^7.12.13\",\n- \"@babel/runtime\": \"^7.13.10\",\n- \"eslint\": \"^7.22.0\",\n- \"eslint-config-prettier\": \"^8.1.0\",\n- \"eslint-plugin-import\": \"^2.22.1\",\n- \"eslint-plugin-jest\": \"^24.3.2\",\n- \"eslint-plugin-jsx-a11y\": \"^6.4.1\",\n- \"eslint-plugin-prettier\": \"^3.3.1\",\n- \"eslint-plugin-react\": \"^7.23.1\",\n- \"eslint-plugin-react-hooks\": \"^4.2.0\",\n- \"jest\": \"^26.6.3\",\n- \"nodemon\": \"^2.0.7\",\n- \"prettier\": \"^2.2.1\",\n- \"ts-node\": \"^9.1.1\",\n- \"typescript\": \"^4.2.3\"\n\n## Installation Requirements\n\nYou will need [NodeJS][nodejs] installed for use with this project.\n\nYou will also need the latest version of [MongoDB][mongodb] installed locally on your machine.\n\n## Configuration\n\nTo 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`.\n\n\u003e 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.\n\n## Usage\n\n**Getting Started**\n\nTo get started with this project, you'll want to install the required dependencies and the React frontend with this command:\n\n```shell\nnpm run install:all\n```\n\n## Development\n\n### Starting the project\n\nWhile working and developing on the source code, you can run a live development server (front and backend) with:\n\n```shell\nnpm run start:dev:watch\n```\n\nTo start just the backend MonogoDB server and work on the API you can run:\n\n```shell\nnpm run start:server\n```\n\nTo start just the React frontend and work on the UI, you can run:\n\n```shell\nnpm run start:client\n```\n\n### Formatting (Prettier)\n\nIt 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:\n\n\u003e This will format both your backend and frontend code with Prettier\n\n```shell\nnpm run format\n```\n\n### Linting (ESLint)\n\nLinting is important! You can statically analyzes your code to quickly find problems with **ESLint** by running:\n\n**Lint check backend code**\n\n```shell\nnpm run lint:check\n```\n\n**Lint check frontend code**\n\n```shell\nnpm run lint:check:client\n```\n\n**Lint check backend and frontend code**\n\n```shell\nnpm run lint:check:all\n```\n\n### Linting Autofix (ESLint)\n\nThis 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:\n\n\u003e Please keep in mind that **_this is not full-proof_**.\n\n**Lint fix backend code**\n\n```shell\nnpm run lint:fix\n```\n\n**Lint fix frontend code**\n\n```shell\nnpm run lint:client:fix\n```\n\n**Lint fix backend and frontend code**\n\n```shell\nnpm run lint:fix:all\n```\n\n## Supported Versions\n\nBelow is a list of the currently supported versions of this software.\n\n\u003e 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.\n\n| Release |       Status       | Initial Release | Active LTS Start | Maintenance LTS Start | End of Life |\n| :-----: | :----------------: | :-------------: | :--------------: | :-------------------: | :---------: |\n| develop |      Unstable      |        -        |        -         |           -           |      -      |\n|   v1    | :heavy_check_mark: |   2021-03-25    |    2021-09-25    |           -           | 2022-03-25  |\n|   v2    |   :construction:   |   2022-03-01    |    2022-09-01    |      2023-03-01       | 2024-03-01  |\n\nYou can view the Status Key Map and software support model [here][support].\n\n## Contributing\n\nContributions are more than welcome! If you improve on this project, please feel free to share it by submitting a Pull Request.\n\nBefore contributing, be sure to check out the [CONTRIBUTING][contrib] and [Branching Model][branching] docs.\n\n## Bugs and Issues\n\nFound a bug? Having an issue with this app? [Open a new issue][issues] here.\n\n## License\n\nThis project and all of its source code is released and permissively licensed under the [BSD 2 Clause][license] license.\n\n[archive]: https://github.com/davidsaulrodriguez/mern-stack-template/archive/main.zip\n[mongodb]: https://www.mongodb.com/try/download/community\n[nodejs]: https://nodejs.com\n[support]: ./SLC.md\n[contrib]: ./CONTRIBUTING.md\n[branching]: ./docs/Branching_Model.md\n[issues]: https://github.com/davidsaulrodriguez/mern-stack-template/issues/new/choose\n[license]: ./LICENSE\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdavidsaulrodriguez%2Fmern-stack-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdavidsaulrodriguez%2Fmern-stack-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdavidsaulrodriguez%2Fmern-stack-template/lists"}