MERNfolio is a Portfolio Builder designed for developers and professionals who want to create and customize their personal portfolio websites using the MERN stack (MongoDB, Express, React, Node.js). With a modern and interactive interface, MERNfolio helps you effectively showcase your skills, projects, and achievements in a highly customizable and engaging way.
- Prototype: Figma Prototype
- Node Server: Backend
- Frontend: Frontend
- Backend Repo: GitHub - Backend
- Frontend Repo: GitHub - Frontend
| Feature | Description |
|---|---|
| 🎨 Customizable Themes & Dark Mode | Choose from multiple themes and toggle between light and dark modes to suit your preference. |
| 🔗 Projects Showcase | Fetch project details dynamically via the GitHub API or manually add images, descriptions, and links. |
| 🏆 Gamified XP-Based Skills | Display your skills with progress bars and experience points, making the portfolio more interactive. |
| 📜 Interactive Timeline | Animated timeline that showcases your education, work experience, and certifications, triggered by scroll. |
| 💬 Friends' Reviews | Add a section for visitors to leave testimonials and feedback on your work. |
| 📌 Profile Switch Mode | Toggle between viewing your personal portfolio or shared profiles with a simple button. |
| ✍️ Blogs & Articles (Optional) | Share your journey, write about GitHub contributions, technical topics, or personal experiences. |
The project is built using the MERN stack, which stands for MongoDB, Express, React, and Node.js. Here's a breakdown of the technologies used:
- Frontend:
- React.js: A powerful JavaScript library for building interactive UIs.
- TailwindCSS (or Styled-components): For highly customizable and responsive UI design.
- Backend:
- Node.js: JavaScript runtime for server-side logic.
- Express.js: Web framework for building RESTful APIs.
- MongoDB: NoSQL database for storing user data, projects, and more.
- Authentication:
- OAuth/Firebase (TBD): For secure user authentication and login.
- Deployment:
- Frontend: Deployed on Netlify or Vercel for fast, serverless deployment.
- Backend: Deployed on Render or Fly.io for easy server deployment.
To run MERNfolio locally and start customizing your portfolio:
- Clone the repository to your local machine:
git clone https://github.com/Priyasha-Yadav/MERNfolio.git
- Navigate into the project directory:
cd MERNfolio - Install the required dependencies:
npm install
- Start the development server:
npm start
- Open the project in your browser:
- Frontend:
http://localhost:3000 - Backend (if set up locally):
http://localhost:5000(default)
- Frontend:
Note: Ensure that you have Node.js installed (preferably version 14.x or above). You may need to set up your MongoDB database and authentication (e.g., Firebase, OAuth) depending on the features you wish to use.
We welcome contributions! To contribute to MERNfolio, follow these steps:
- Fork the repository to your own GitHub account.
- Create a new branch for your feature or bugfix:
git checkout -b feature-branch-name
- Make your changes and commit them with clear and descriptive messages.
- Push your changes to your fork:
git push origin feature-branch-name
- Open a pull request (PR) for review.
This project is open-source and licensed under the MIT License. See the LICENSE file for more information.