Skip to content

Yogen-Pokhrel/portfolio

Repository files navigation

Portfolio Website Creator

Portfolio Website Creator is an open-source project designed to empower individuals to create personalized, professional portfolio websites. It is built for the community, fostering creativity and simplicity for anyone, from engineers to artists, doctors, and more.


🚀 Features

  • Customizable Templates: Choose from a variety of elegant and responsive templates tailored to showcase your expertise. (In Development)
  • User-Friendly Interface: Build your portfolio without coding knowledge using an intuitive UI. (Planned Feature)
  • Authentication: Secure login and account management with Keycloak integration.
  • Dynamic Content: Easily update your portfolio with projects, achievements, and media.
  • Scalable Backend: Built with a robust backend to handle multiple users seamlessly.
  • Fundraising Support: Option to contribute funds to maintain the platform and support server costs.

🎯 Project Status

This project is in its early development phase. The backend services are being established, and the front-end templates are currently under active development. Contributions and suggestions are highly encouraged to shape the platform's future.


🛠️ Technology Stack

  • Backend: Java, Spring Boot, Hibernate, Keycloak
  • Frontend: React, SCSS (In Development)
  • Database: MongoDB, PostgreSQL
  • Cloud: AWS (S3, EC2)
  • Deployment: Docker, Kubernetes
  • Others: Swagger for API documentation

📜 License

This project is licensed under the Apache License 2.0.
You are free to:

  • Use — The project for personal and community purposes.
  • Modify — Customize the project to fit your needs.
  • Distribute — Share the code freely while adhering to the license terms.

For more details, see the LICENSE file or visit the Apache License 2.0 official page.


💻 Getting Started

Prerequisites

  • Java 17+
  • Node.js 16+
  • Docker & Docker Compose
  • MongoDB/PostgreSQL running locally or on a cloud instance

Installation

  1. Clone the repository:
    git clone https://github.com/yourusername/portfolio-website-creator.git
  2. Navigate to the project directory:
    cd portfolio-website-creator
  3. Build the backend:
    ./gradlew build
  4. Start the services:
    docker-compose up

📖 Documentation

  • API Documentation: Swagger UI
  • User Guide: (To be added as the project progresses)

🤝 Contributions

Contributions are welcome! Please fork the repository and create a pull request for any changes.
See the CONTRIBUTING.md file for more details.


💡 How to Support

If you'd like to support this project:

  1. Spread the word by sharing it with your network.
  2. Contribute via the Donate button on the project website. (Planned Feature)
  3. Provide feedback to help us improve the platform.

🌟 Acknowledgments

  • Inspired by the open-source community.
  • Special thanks to contributors and users who make this project possible.

About

This is a generic portfolio website, where one can customize as per their needs

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages