Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

updated readme.md content #204

Open
wants to merge 1 commit into
base: PART_1_and_2
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
79 changes: 77 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,80 @@ By the end of this video, you will have a strong understanding of how the MERN S
### [🌟 Become a top 1% Next.js 13 developer in only one course](https://jsmastery.pro/next13)
### [🚀 Land your dream programming job in 6 months](https://jsmastery.pro/masterclass)

Setup:
- run ```npm i && npm start``` for both client and server side to start the app
## Prerequisites

Ensure you have the following installed:
-Node.js (v14.x or above)
-MongoDB (locally or via MongoDB Atlas)
-Git

## Setup Instructions

1. Clone the Repository
git clone https://github.com/adrianhajdin/project_mern_memories.git
cd project_mern_memories

2. Install Dependencies

For the Server:
cd server
npm install

For the Client:
cd ../client
npm install

3. Environment Variables

Create a .env file inside the Server directory and add the Following:
PORT=5000
MONGO_URI=<your_mongo_uri>
JWT_SECRET=<your_jwt_secret>
CLOUDINARY_NAME=<your_cloudinary_name>
CLOUDINARY_API_KEY=<your_cloudinary_api_key>
CLOUDINARY_API_SECRET=<your_cloudinary_api_secret>

4. Running the project

Server:
cd server
npm start

Client:
cd client
npm start

Navigate to http://localhost:3000 to view the application.

## Folder Structure

project_mern_memories/
├── client/ # React frontend
├── server/ # Node.js backend
├── README.md # Project documentation
└── .gitignore # Files to be ignored by Git

## Contributing

1. Fork the repository.
2. Create a new branch: git checkout -b feature-branch.
3. Make your changes.
4. Push the changes: git push origin feature-branch.
5. Create a pull request.

# Deployment

You can deploy the backend to services like Heroku and the frontend to Netlify.

-Heroku Setup:

1. Link your Heroku project.
2. Set environment variables in the Heroku dashboard.
3. Deploy from GitHub.

-Netlify Setup:

1. Connect your Netlify project to your GitHub repo.
2. Deploy the frontend by setting the build command to npm run build and the publish directory to client/build.