Skip to content

gauriket/nekomancer

Repository files navigation

Nekomancer Portfolio Website

Welcome to the Nekomancer Portfolio Website repository! This website is built with React JS, Three JS, and styled-components.

Visit the Website

Explore the live version of the website by clicking here.

Installation and Setup Instructions

To set up this project on your local machine, follow these steps:

Prerequisites

Make sure you have the following software installed:

  • Node.js
  • npm (Node Package Manager)

Installation

  1. Clone this repository to your local machine:

git clone https://github.com/your-username/nekomancer-portfolio.git

  1. Navigate to the project directory:

cd nekomancer-portfolio

  1. Install project dependencies:

npm install

Starting the Development Server

To start the development server and view the project locally, run the following command:

npm run dev

Contribution Guidelines

We welcome contributions to improve this project. Follow these guidelines if you'd like to contribute:

Getting Started

  1. Fork this repository to your GitHub account.
  2. Clone your forked repository to your local machine:

git clone https://github.com/your-username/nekomancer-portfolio.git

  1. Create a new branch for your feature:

git checkout -b feature/your-feature

Reporting Issues

Before opening a new issue, check if it already exists. When reporting issues or feature requests:

  • Clearly describe the problem or feature request.
  • Provide steps to reproduce if it's a bug.

Pull Requests

When submitting a pull request, make sure to:

  • Keep your code well-documented and adhere to the project's coding style.
  • Thoroughly test your changes.
  • Ensure your branch is up-to-date with the main branch.

Provide a clear title and description for your pull request.

Code Style

Follow the coding style used in the project to maintain clean and readable code.

Documentation

Update the documentation for any changes in functionality. Provide examples where necessary.

Licensing

By contributing, you agree that your contributions will be licensed under the project's [LICENSE].

Thank you for your contribution!