MERN Starter npm Package

This open-source project provides a pre-configured starter template for building full-stack applications using the MERN stack (MongoDB, Express, React, Node.js).

It offers a well-organized structure for both the frontend and backend, enabling developers to get started quickly without the need for complex setup.

Table of Contents

1. Package Release
2. Using the Package
3. Key Features
4. Contributing
5. Current Contributors

Package Release

This is the second release of the package with the following features:

• Frontend and backend folders with a basic folder structure.
• Authentication setup with MongoDB and JWT.
• Auth0 Integration for social login (Google, Facebook, etc.).
• Sidebar Navigation for a better user experience.

Using the Package

Create the Starter App

npm create mern-starter@latest your-app-name

Change Directory to the Project Folder

Navigate into the project folder:

cd your-app-name

Install Dependencies

The project includes both frontend and backend code. Install dependencies for each:

# For frontend dependencies
cd frontend
npm install

# For backend dependencies
cd ../backend
npm install

Note: Configure the .env variables for the database connection, authentication, and port.

• Frontend will run on localhost:5173
• Backend will run on localhost:5000

Important: Before pushing the project to GitHub, ensure to uncomment the .env variables in the .gitignore file. This allows the .env file to be tracked by Git and prevents it from being ignored.

Key Features

• Organized Structure: Clear separation of frontend and backend folders for easy navigation and development.
• Pre-configured Setup: Ready-to-use development configurations for both frontend and backend.
• Extendable and Production-Ready: Easily customizable for adding features and ready for production deployment.

Contributing

We welcome contributions from the community. To contribute to the project, follow the steps below:

1. Fork the Repository

Start by forking the repository to your own GitHub account.

2. Clone the Repository Locally

git clone https://github.com/YashChavanWeb/__open-source-project__MERN-starter-package.git

3. Change Directory to the Project Folder

cd __open-source-project__MERN-starter-package

4. Install Dependencies

# For frontend
cd frontend
npm install

# For backend
cd ../backend
npm install

5. Implement Your Changes

Make the necessary changes or additions to the project. Ensure your code follows the existing style and structure.

6. Commit and Push

Commit your changes and push them to your forked repository.

7. Submit a Pull Request (PR)

Once your changes are complete, submit a pull request for review.

Code Style and Documentation

Please ensure your code adheres to the existing style guide and includes clear documentation. This will help streamline the process and improve the overall quality of the project.

Current Contributors

• Yash Chavan – GitHub Profile
• Anjali Gupta – GitHub Profile