Skip to content

codehasan/codehasan.github.io

Repository files navigation

Contributors Forks Stargazers MIT License


Logo

Full-stack Developer Portfolio

A website to showcase your skills and projects with minimal styles
How to setup »

View Demo · Report Bug

Table of Contents
  1. About The Project
  2. Getting Started
  3. Contributing
  4. License
  5. Contact
  6. Acknowledgments

About The Project

Project Screenshot

There are many great portfolio templates available on GitHub, Colorlib and FreeCss. However, I didn't find one that really suited my needs. So, I created this one with minimal fanciness.

Here's why:

  • As a backend or backend-heavy full-stack developer, your time should be focused on creating something amazing that will increase and help showcase your skills to recuiters.
  • You shouldn't be spending days or weeks designing a portfolio website from scratch.

Of course, no one template may serve all your needs. That's why this project is made using React. So that, you can add your own components according to your needs on your desired places.

Built With

  • React
  • TypeScript
  • Styled Components
  • Fontawesome
  • Vite

Getting Started

Follow the instructions to setup the project locally, and deploy it on GitHub Pages.

Prerequisites

Make sure you have either npm or yarn installed and upgraded to the latest version.

You also need git to clone this repo locally.

Local Setup

To run and test the project locally in your computer, follow the below steps.

  1. Clone the repo
    git clone https://github.com/codehasan/codehasan.github.io.git
  2. Open the cloned directory
    cd codehasan.github.io
  3. Install NPM packages
  • npm
    npm install
  • yarn
    yarn
  1. Run the website in a browser
    npm run dev

Configuration

  1. Edit homepage attribute in package.json and set it to your domain. If you're deploying in github pages, it will be, https://<github-username>.github.io

Deploy

  • Build the project
    npm run build
Deploy in GitHub Pages
  1. Create a repository with the name, <github-username>.github.io. Here, <github-username> should be replaced with your actual github username.
  2. Push the local project files in this repository.
  3. Open settings of your repository, navigate to Pages section. Select the branch where you pushed your files.
  4. Select the root folder to be the folder where npm generated the built project files. By default, it will be dist folder.

Back to top

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE.txt for more information.

The MIT License (MIT)

Copyright (c) 2024 Ratul Hasan

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

Contact

  • LinkedIn
  • Telegram
  • Twitter
  • Gmail

Acknowledgments

I took design ideas from a few repositories listed below by their owner's name.

Back to top