Skip to content

Commit

Permalink
Closes atherosai#40, Closes atherosai#32 some fixes for README file
Browse files Browse the repository at this point in the history
  • Loading branch information
abdelrahman-mh committed Mar 13, 2024
1 parent 7938b8d commit e49b452
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 23 deletions.
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
.DS_Store
node_modules
node_modules
.vscode
54 changes: 32 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,48 @@
This is repository with examples of simple UI components. The repository is based on Next.js and React.js.
This is repository with examples of simple UI components. The repository is based on Next.js and React.js.

# installation

* Clone the repo with
```
git clone git@github.com:atherosai/ui.git
```
- Clone the repo with

```shell
git clone git@github.com:atherosai/ui.git
```

# For HTML/CSS/JS

Just navigate to the folder with your chosen example and open html file in the browser.

# For React Examples

* Install npm packages
```
npm i
```
* Run development mode
```
npm run dev
```
- Navigate to project folder

```shell
cd <example_folder>
```

- Install npm dependencies

```shell
npm install
```

Now the app is accessible at ```localhost:3000```
- Run development mode

```shell
npm run dev
```

Now the app is accessible at `localhost:3000`

# My Social Media
The examples are posted here:

* [TikTok](https://www.tiktok.com/@davidm_ai)
* [Instagram](https://www.instagram.com/davidm_ai/)
* [Youtube](https://www.youtube.com/@Atheroslearning)
* [Twitter](https://twitter.com/davidm_ml)
* [Linkedin](https://www.linkedin.com/in/david-mraz/)
* [Threads](https://www.threads.net/@davidm_ai)
The examples are posted here:

* Learn more at [Atheros Learning](https://learning.atheros.ai)! HTML and CSS course is coming this month!
- [TikTok](https://www.tiktok.com/@davidm_ai)
- [Instagram](https://www.instagram.com/davidm_ai/)
- [Youtube](https://www.youtube.com/@Atheroslearning)
- [Twitter](https://twitter.com/davidm_ml)
- [Linkedin](https://www.linkedin.com/in/david-mraz/)
- [Threads](https://www.threads.net/@davidm_ai)

- Learn more at [Atheros Learning](https://learning.atheros.ai)! HTML and CSS course is coming this month!

0 comments on commit e49b452

Please sign in to comment.