Skip to content

Latest commit

 

History

History
175 lines (126 loc) · 6.99 KB

README.md

File metadata and controls

175 lines (126 loc) · 6.99 KB
Raw

🌐 Dileepa Bandara - Personal Website

Welcome to my personal website project, hosted at dileepa.dev. This website is designed to showcase my portfolio, share information about me, and provide a platform for sharing my thoughts and experiences.

📚 Table of Contents

📸 Captured Media

Screenshot of dileepa.dev

🌟 Features

  • About: Get to know my background, goals, and interests.
  • Education: Discover my academic qualifications and institutions.
  • Experience: Explore my professional work and volunteer experience.
  • Media: Check out my latest articles, videos, and other content.
  • Connect: Connect with me through social media and other communication channels.

🛠️ Technologies

This website is built using the following technologies:

  • HTML - Markup language used to structure and present content on the web.
  • CSS - Stylesheet language used to design the HTML content.
  • JavaScript - Programming language that conforms to the ECMAScript specification.
  • TypeScript - Typed superset of JavaScript that compiles to plain JavaScript.
  • React - JavaScript library for building user interfaces.
  • Next.js - React framework for building static and server-side rendered websites.
  • Tailwind CSS - Utility-first CSS framework for rapidly building custom designs.
  • Node.js - JavaScript runtime built on Chrome's V8 JavaScript engine.
  • Resend - Platform to build, test, and deliver transactional emails.

📌 Getting Started

⚡ Prerequisites

⚙️ Installation

To get a copy of this project up and running on your local machine, follow these steps:

  1. Clone this repository:

    git clone https://github.com/dileepadev/dileepa.dev.git

  2. Navigate to the project directory:

  3. Install the dependencies:

    npm install
# or
yarn install
# or
pnpm install
# or
bun install

  4. Start the development server:

    npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev
# or
npx next dev

  5. Open http://localhost:3000 with your browser to see the result. To change the port, use the -p flag. For example, npm run dev -p 4000.

  6. You can start editing the page by modifying app/page.tsx. The page auto-updates as you edit the file.

  7. Create .env.local file to save environment variables. This project uses RESEND_API_KEY variable for Resend API.

    This is how the .env.local file should look like:

    RESEND_API_KEY=YOUR-API-KEY-HERE

📘 Learn More About Next.js

To learn more about Next.js, take a look at the following resources:

🚀 Deployment

  • This website is hosted on Vercel, a cloud platform for static sites and Serverless Functions.
  • Any changes pushed to the main branch will be automatically deployed to dileepa.dev.
  • Any changes pushed to the dev branch will be automatically deployed to preview.dileepa.dev.

🍃 Branches

  • Branches are an important part of this project. They are used to develop new features, fix bugs, and make changes to the source code. The following branches are used in this project:

    • main - The source code for the latest stable and production-ready release of the website.
    • dev - New features and bug fixes that are being worked on but not yet ready for production. Only for preview upcoming changes.
    • feat/* - Branches used to develop new features.
    • fix/* - Branches used to fix bugs.
    • ... and more.

  • Check out the branch naming guidelines for more information.

🕹️ Versioning

  • This project uses Semantic Versioning for versioning.
  • Each release is documented in the CHANGELOG.md file.
  • Visit the releases page to see the all releases.
  • Visit the tags page to see the all tags.
  • Each release is in the format of v*.*.*, where * is a number and v is a prefix for the tag.
  • Version numbers are incremented according to the X.Y.Z format.
    • MAJOR: X is incremented for incompatible API changes.
    • MINOR: Y is incremented for new functionality in a backwards-compatible manner.
    • PATCH: Z is incremented for backwards-compatible bug fixes.

Example:

Version Description
0.1.0 Early stage of development
1.0.0 Initial release
1.1.0 New contact form added (backwards-compatible)
1.1.1 Fixed typo on homepage (backwards-compatible)
1.2.0 Added new blog section (backwards-compatible)
2.0.0 Rebrand with new theme (incompatible)

🖼️ Icons and Images

Icons used in this website are from React Icons and Heroicons.

📜 License

This project is licensed under the MIT License.
MIT © Dileepa Bandara
See the license file here: LICENSE

💬 Contact

If you have any questions or comments about this project, please feel free to reach out to me at [email protected].

💙 Contributing

If you find any issues with this project or would like to suggest changes, feel free to submit a pull request or open an issue. Please make sure to follow guidelines at CONTRIBUTING.md before your contribution.

❤️ Thanks

Thanks to everyone who supported.