+
+ Step 1: Clone the repository
+
+
+
Note: Make sure that that you have
+
Git
+ installed on your machine, as it is required to clone repositories.
+
+
+ To clone the Tailwind Elements repository from GitHub, follow these steps:
+
+
+ 1. Go to the
+ Tailwind Elements repository
+ on GitHub.
+
+
+ 2. Click on the "Code" button, located above the file list on the
+ repository's main page.
+
+
+ 3. In the dropdown that appears, click on the clipboard icon to copy the
+ repository's clone URL.
+
+
+ 4. Open your preferred command line interface (CLI) or terminal.
+
+
+ 5. Navigate to the directory where you want to clone the repository using
+ the cd command:
+
+
+ {{< twsnippet/wrapper "terminal" "" "mobile" >}}
+ {{< twsnippet/code active=true lang="Plaintext" type="terminal" >}}
+ cd /path/to/directory
+ {{< /twsnippet/code >}}
+ {{< /twsnippet/wrapper >}}
+
+
+ 6. In the terminal, paste the previously copied clone URL and run the
+ following command to clone the repository:
+
+
+ {{< twsnippet/wrapper "terminal" "" "mobile" >}}
+ {{< twsnippet/code active=true lang="Plaintext" type="terminal" >}}
+ git clone https://github.com/mdbootstrap/Tailwind-Elements.git
+ {{< /twsnippet/code >}}
+ {{< /twsnippet/wrapper >}}
+
+
+ 7. Once the cloning process is complete, navigate into the cloned
+ repository's directory.
+
+
+ 8. If you are searching for specific versions of Tailwind Elements, you can
+ use the following command to list all available tags:
+
+
+ {{< twsnippet/wrapper "terminal" "" "mobile" >}}
+ {{< twsnippet/code active=true lang="Plaintext" type="terminal" >}}
+ git tag -l
+ {{< /twsnippet/code >}}
+ {{< /twsnippet/wrapper >}}
+
+
+ 9. Then you can checkout the desired version (e.g.
+ v1.0.0-beta1) using the following command:
+
+
+ {{< twsnippet/wrapper "terminal" "" "mobile" >}}
+ {{< twsnippet/code active=true lang="Plaintext" type="terminal" >}}
+ git checkout v1.0.0-beta1
+ {{< /twsnippet/code >}}
+ {{< /twsnippet/wrapper >}}
+
+
+
+ Step 2: Install dependencies
+
+
+
Note: Make sure that that you have
+
Node.js (LTS)
+ installed on your machine.
+
+
To install all necessary dependencies, follow these steps:
+
+ 1. Open your preferred command line interface (CLI) or terminal.
+
+
+ 2. Navigate to the root directory of your project using the
+ cd command:
+
+
+ {{< twsnippet/wrapper "terminal" "" "mobile" >}}
+ {{< twsnippet/code active=true lang="Plaintext" type="terminal" >}}
+ cd /path/to/project
+ {{< /twsnippet/code >}}
+ {{< /twsnippet/wrapper >}}
+
+
3. Run the following command to install all dependencies:
+
+ {{< twsnippet/wrapper "terminal" "" "mobile" >}}
+ {{< twsnippet/code active=true lang="Plaintext" type="terminal" >}}
+ npm install
+ {{< /twsnippet/code >}}
+ {{< /twsnippet/wrapper >}}
+
+
+ This command will read the package.json file and download all
+ the necessary dependencies into a node_modules folder.
+
+
+ 4. In addition to installing the project dependencies, you may also need to
+ install the dependencies required for the documentation. To ensure it run
+ the following command:
+
+
+ {{< twsnippet/wrapper "terminal" "" "mobile" >}}
+ {{< twsnippet/code active=true lang="Plaintext" type="terminal" >}}
+ npm run docs:install
+ {{< /twsnippet/code >}}
+ {{< /twsnippet/wrapper >}}
+
+
+
Note: Ensure that
+
Hugo
+ is installed on your device as it is a prerequisite for accessing our
+ documentation.
+
+
+
+ Step 3: Running the Demo App and Documentation
+
+
+ Once you have successfully installed the dependencies for your project, you
+ can proceed with utilizing them in your development workflow.
+
+
+
Note: Before attempting to start a specific version of
+ Tailwind Elements, it is crucial to ensure that you have followed all the
+ instructions outlined in
+
Step 1.
+
+
+ 1. To start the demo application, run the following command in your
+ terminal:
+
+
+ {{< twsnippet/wrapper "terminal" "" "mobile" >}}
+ {{< twsnippet/code active=true lang="Plaintext" type="terminal" >}}
+ npm start
+ {{< /twsnippet/code >}}
+ {{< /twsnippet/wrapper >}}
+
+
+ 2. Launch the documentation by executing the following command:
+
+
+ {{< twsnippet/wrapper "terminal" "" "mobile" >}}
+ {{< twsnippet/code active=true lang="Plaintext" type="terminal" >}}
+ npm run docs:start
+ {{< /twsnippet/code >}}
+ {{< /twsnippet/wrapper >}}
+
+
+ Note: Prior to running the documentation, it is important
+ to execute the command npm run build to compile the Tailwind
+ plugin and update the files located in the /site directory.
+
+