-
-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
3313827
commit 57d77bb
Showing
1 changed file
with
20 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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. Install the dependencies**: | ||
**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 | ||
``` | ||
|
||
**5. Install the dependencies**: | ||
|
||
```Node | ||
```bash | ||
npm install | ||
``` | ||
|
||
**5. Start the development server**: | ||
**6. Start the development server**: | ||
|
||
```Node | ||
```bash | ||
npm run dev | ||
``` | ||
|
||
**6. Run linter**: | ||
**7. 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 [[email protected]](mailto:[email protected]). |