From e8644c2f97c171d5d463d24e62fd02feec5327ab Mon Sep 17 00:00:00 2001 From: Michael Tamaki Date: Tue, 2 Jul 2024 05:01:54 +0000 Subject: [PATCH] Fix README styling --- README.md | 25 +++++++++++++++++-------- 1 file changed, 17 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 8d91f18..5d6356d 100644 --- a/README.md +++ b/README.md @@ -8,47 +8,56 @@ :books: **Features** of our project include a dynamic and responsive user interface powered by NextJS & React, stylish components with Tailwind CSS, and smooth animations and transitions through Framer Motion to enhance the user experience. -🚀 **Getting Started** +## 🚀 Getting Started To contribute to this project, follow these steps: **1. Fork the Repository**: Click the "Fork" button at the top right corner of this repository's page. This will create a copy of the project in your GitHub account. + **2. Clone Your Fork**: Now, you need to clone your forked repository to your local machine. Replace [your-username] with your GitHub username in the URL below: -```Node +```bash git clone https://github.com/[your-username]/website.git ``` **3. Navigate to the project directory**: -```Node +```bash cd website ``` +**4. Set the NodeJS version**: + +You can utilize [nvm](https://github.com/nvm-sh/nvm) (Node Version Manager) to use the project's specific NodeJS version: + +```bash +nvm use +``` + **4. Install the dependencies**: -```Node +```bash npm install ``` **5. Start the development server**: -```Node +```bash npm run dev ``` **6. Run linter**: -```Node +```bash npm run lint ``` Now you're ready to contribute. Make your changes, commit them, and then create a **pull request** to submit your contributions. Thank you for contributing to CodeWithAloha! -:clipboard: **License** +## :clipboard: License This project is licensed under the MIT License. -:speech_balloon: **Contact** +## :speech_balloon: Contact For inquiries and feedback, please reach out to [codewithaloha@gmail.com](mailto:codewithaloha@gmail.com).