# MERNcraft
MERNcraft is an automation script designed to kickstart your MERN stack application development. It helps you set up a basic project structure with React for the frontend and Express for the backend.
## MERNcraft on GitHub
View the MERNcraft project on GitHub [here](https://github.com/Hardvan/MERNcraft).
## Features
- **Frontend Setup**: Creates a React application using `create-react-app`.
- **Backend Setup**: Sets up a basic Express server with a sample `server.js` file.
- **Project Structure**: Organizes the project into `frontend/` and `backend/` directories.
- **Top-Level Files**: Includes a `README.md` and `.gitignore` for project documentation and Git management.
## Use Cases
- Quickly start a new MERN project with a clean structure.
- Prototype MERN stack applications.
- Automate the setup of MERN projects for testing or learning purposes.
## Bonus: How to Deploy a MERN Stack Application on Vercel (Frontend - React) and Render (Backend - Express)
[This repository](https://github.com/Hardvan/How-to-Deploy-a-MERN-App-to-Vercel-and-Render) contains the step-by-step guide to deploy a MERN stack application on Vercel and Render. It includes the following:
- Deploying the React frontend on Vercel.
- Deploying the Express backend on Render.
- Connecting the frontend and backend for a complete MERN stack application.
- Setting up environment variables for the frontend and backend.
## Getting Started
1. **Run the Automation Script**
Install the MERNcraft package from PyPI using pip:
```bash
pip install MERNcraft
```
OR
Clone this repository or download the script and run it to create your project structure:
```bash
git clone https://github.com/Hardvan/MERNcraft
cd MERNcraft
python MERNcraft.py
```
The script will:
- Create the project directories and files.
- Set up the React frontend.
- Set up the Express backend.
- Generate a `README.md` and `.gitignore` file.
2. **Start the Frontend**
Navigate to the `frontend` directory and start the React app:
```bash
cd frontend
npm start
```
Open `http://localhost:3000` to view your React app.
3. **Start the Backend**
Navigate to the `backend` directory and start the Express server:
```bash
cd backend
npm run dev
```
Open `http://localhost:5000` to view your Express server.
## Project Files
- **MERNcraft.py**: The main automation script that sets up your MERN project.
- **frontend/**: Contains the React application created with `create-react-app`.
- **backend/**: Contains the Express server setup.
- **server.js**: The entry point for the Express server.
- **models/**: Directory for database models.
- **routes/**: Directory for API routes.
- **controllers/**: Directory for handling business logic.
- **README.md**: Project documentation (this file).
- **.gitignore**: Contains files and directories to be ignored by Git.
## Notes
- Ensure you have Node.js and Python installed to run the automation script and manage dependencies.
- Customize your React and Express applications as needed.
Happy coding! 🚀
Raw data
{
"_id": null,
"home_page": "https://github.com/Hardvan/MERNcraft",
"name": "MERNcraft",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "automation, mern, project, create-react-app, express, mongodb",
"author": "Hardik Pawar",
"author_email": "hardikpawarh@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/62/e5/b403a28fce6f9a94c52bd5c6bff27bfb0d65d4fdc4a64c3ee2bc830ec019/MERNcraft-1.0.19.tar.gz",
"platform": null,
"description": "# MERNcraft\r\n\r\nMERNcraft is an automation script designed to kickstart your MERN stack application development. It helps you set up a basic project structure with React for the frontend and Express for the backend.\r\n\r\n## MERNcraft on GitHub\r\n\r\nView the MERNcraft project on GitHub [here](https://github.com/Hardvan/MERNcraft).\r\n\r\n## Features\r\n\r\n- **Frontend Setup**: Creates a React application using `create-react-app`.\r\n- **Backend Setup**: Sets up a basic Express server with a sample `server.js` file.\r\n- **Project Structure**: Organizes the project into `frontend/` and `backend/` directories.\r\n- **Top-Level Files**: Includes a `README.md` and `.gitignore` for project documentation and Git management.\r\n\r\n## Use Cases\r\n\r\n- Quickly start a new MERN project with a clean structure.\r\n- Prototype MERN stack applications.\r\n- Automate the setup of MERN projects for testing or learning purposes.\r\n\r\n## Bonus: How to Deploy a MERN Stack Application on Vercel (Frontend - React) and Render (Backend - Express)\r\n\r\n[This repository](https://github.com/Hardvan/How-to-Deploy-a-MERN-App-to-Vercel-and-Render) contains the step-by-step guide to deploy a MERN stack application on Vercel and Render. It includes the following:\r\n\r\n- Deploying the React frontend on Vercel.\r\n- Deploying the Express backend on Render.\r\n- Connecting the frontend and backend for a complete MERN stack application.\r\n- Setting up environment variables for the frontend and backend.\r\n\r\n## Getting Started\r\n\r\n1. **Run the Automation Script**\r\n\r\n Install the MERNcraft package from PyPI using pip:\r\n\r\n ```bash\r\n pip install MERNcraft\r\n ```\r\n\r\n OR\r\n\r\n Clone this repository or download the script and run it to create your project structure:\r\n\r\n ```bash\r\n git clone https://github.com/Hardvan/MERNcraft\r\n cd MERNcraft\r\n python MERNcraft.py\r\n ```\r\n\r\n The script will:\r\n\r\n - Create the project directories and files.\r\n - Set up the React frontend.\r\n - Set up the Express backend.\r\n - Generate a `README.md` and `.gitignore` file.\r\n\r\n2. **Start the Frontend**\r\n\r\n Navigate to the `frontend` directory and start the React app:\r\n\r\n ```bash\r\n cd frontend\r\n npm start\r\n ```\r\n\r\n Open `http://localhost:3000` to view your React app.\r\n\r\n3. **Start the Backend**\r\n\r\n Navigate to the `backend` directory and start the Express server:\r\n\r\n ```bash\r\n cd backend\r\n npm run dev\r\n ```\r\n\r\n Open `http://localhost:5000` to view your Express server.\r\n\r\n## Project Files\r\n\r\n- **MERNcraft.py**: The main automation script that sets up your MERN project.\r\n- **frontend/**: Contains the React application created with `create-react-app`.\r\n- **backend/**: Contains the Express server setup.\r\n - **server.js**: The entry point for the Express server.\r\n - **models/**: Directory for database models.\r\n - **routes/**: Directory for API routes.\r\n - **controllers/**: Directory for handling business logic.\r\n- **README.md**: Project documentation (this file).\r\n- **.gitignore**: Contains files and directories to be ignored by Git.\r\n\r\n## Notes\r\n\r\n- Ensure you have Node.js and Python installed to run the automation script and manage dependencies.\r\n- Customize your React and Express applications as needed.\r\n\r\nHappy coding! \u00f0\u0178\u0161\u20ac\r\n\r\n\r\n",
"bugtrack_url": null,
"license": null,
"summary": "MERNcraft is an automation script designed to kickstart your MERN stack application development. It helps you set up a basic project structure with React for the frontend and Express for the backend.",
"version": "1.0.19",
"project_urls": {
"Homepage": "https://github.com/Hardvan/MERNcraft"
},
"split_keywords": [
"automation",
" mern",
" project",
" create-react-app",
" express",
" mongodb"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e480a0a9c04f5f66c0ea9f9e4ab50b7fe4efb3494c666228e8beb7c1d0403e38",
"md5": "75b6358d4e237caf7ccb6f20272d493a",
"sha256": "5de83b5a8691f997e55cb576ff6f978929bfa39dd7c10b56b8d95c0bc80b2a90"
},
"downloads": -1,
"filename": "MERNcraft-1.0.19-py3-none-any.whl",
"has_sig": false,
"md5_digest": "75b6358d4e237caf7ccb6f20272d493a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 7851,
"upload_time": "2024-09-21T15:01:18",
"upload_time_iso_8601": "2024-09-21T15:01:18.232151Z",
"url": "https://files.pythonhosted.org/packages/e4/80/a0a9c04f5f66c0ea9f9e4ab50b7fe4efb3494c666228e8beb7c1d0403e38/MERNcraft-1.0.19-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "62e5b403a28fce6f9a94c52bd5c6bff27bfb0d65d4fdc4a64c3ee2bc830ec019",
"md5": "2a2402818ad1d9efa41a42a3c222299a",
"sha256": "dac9c3860d50f0a492b48055a060f60457d88c10fe3b35afdc2c1c3cfea88d11"
},
"downloads": -1,
"filename": "MERNcraft-1.0.19.tar.gz",
"has_sig": false,
"md5_digest": "2a2402818ad1d9efa41a42a3c222299a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 8263,
"upload_time": "2024-09-21T15:01:22",
"upload_time_iso_8601": "2024-09-21T15:01:22.552423Z",
"url": "https://files.pythonhosted.org/packages/62/e5/b403a28fce6f9a94c52bd5c6bff27bfb0d65d4fdc4a64c3ee2bc830ec019/MERNcraft-1.0.19.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-21 15:01:22",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Hardvan",
"github_project": "MERNcraft",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "merncraft"
}
JSON
