MERNboilerplate

MERN Infrastructure Boilerplate

This is a clean template to serve as a useful tool to create full-stack MERN applications with JWT Authorization utilizing the MERN stack, REST Architecture, and MVC Framework.
Explore the docs »
View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Roadmap
4. Contributing
5. Contact
6. Acknowledgments

About The Project

This application provides all the basic and necessary functionality needed for any MERN Application.

• User Authentication & Authorization
• API Controllers
• MVC Framework
• RESTful Architecture

(back to top)

Built With

• Mongoose
• MongoDB
• Express.js
• REACT
• Node.js
• JWT

(back to top)

Getting Started

How to set this up locally

To get a local copy up and running follow these simple steps.

Prerequisites

• npm

  npm install npm@latest -g
  

• node.js Download & install node.js

Installation

1. Get Excited! - Good or bad, you’re embarking on a new adventure!
2. Clone the repo

   git clone https://github.com/Antonomy/MERNboilerplate.git
   

3. Install NPM packages

   npm i
   

4. Duplicate the .env-example file and rename it to .env.
5. Update MONGO_URI and SECRET to your own.

    MONGO_URI=mongodb+srv://xxx
    SECRET=thiscanbeanythingyouwant
   

6. Start Back-End

   npm run dev
   

7. Start Front-End

   npm run react
   

(back to top)

Roadmap

• User Sign Up, Login, Logout
• RESTful Architecture
• CRUD Capability
• MVC Framework

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag “enhancement”. Don’t forget to give the project a star ⭐! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

Contact

(back to top)

Acknowledgments

• Friends and Family - Life wouldn’t be as fun without you in it. Thank you for putting up with me.
• Third Degree Burns Family - We made it through and you were all a part of making me the engineer I am.

(back to top)