Nheek

Nheek is my personal portfolio website where I showcase projects that I make that I feel like the world should see.

Table of Contents

• Getting Started
  • Prerequisites
  • Installation
  • Development
• Usage
• Deployment
• Built With
• Contributing
• License
• Acknowledgments

Getting Started

The installation is pretty straightforward, just follow the steps below and you should be good to go.

Prerequisites

• Node.js
• npm (usually comes with Node.js installation)

Installation

1. Clone the repository:

   git clone https://github.com/nheek/nheek..git your-project

2. Change into the project directory:

   cd your-project

3. Install dependencies:

   npm install

Development

Run the development server:

npm run dev

Usage

Nheek can be used to store your projects and have a hook for potential employers to see. It also has social links to link to your social media accounts and gives easy access to contact you. Otherwise, there's also a contact form that currently saves the data to a database. The website is also multilingual and you can follow the existing format and conditions to add your own preferred language.

Deployment

1. Build the project files

npm run build

2. Run using the NextJS command or use your production deployment method

npm start

Built With

• NextJS
• ReactJS
• TailwindCSS
• Typescript

Contributing

If you'd like to contribute, please fork the repository and create a pull request. Issues and feature requests are welcome!

License

This project is licensed under the GNU General Public License v3.0 - see the LICENSE file for details.

Acknowledgments

Special thanks to everyone who had indirect contributions to this project through the inclusion of their works which are specially mentioned in the source code.