Skip to content
This repository was archived by the owner on May 4, 2025. It is now read-only.

Commit ae16aac

Browse files
committed
Updated README
1 parent 12ca942 commit ae16aac

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33

44
A space for YOU to showcase YOUR projects!
55

6+
---
7+
68
## How to Add Your Project
79
Welcome! We're excited to showcase your project. Follow these simple steps to add your work to our collection.
810

@@ -45,3 +47,30 @@ Here are some commonly used tags:
4547
- If you're unsure about image hosting, we recommend using [Postimg](https://postimages.org/)
4648
- For JSON validation, use [JSONLint](https://jsonlint.com/)
4749
- If you have questions, open an issue in the repository
50+
51+
52+
## How to run locally?
53+
54+
1. Clone the repo
55+
```sh
56+
git clone https://github.com/FOSS-Cell-GECPKD/Breakpoint
57+
```
58+
59+
2. Install the required packages
60+
```sh
61+
npm i
62+
```
63+
64+
3. Run in development mode
65+
```sh
66+
npm run dev
67+
```
68+
69+
## Technology Used
70+
- Typescript
71+
- Tailwind
72+
- Vite
73+
Libraries used:
74+
- lucide-react
75+
- framer-motion
76+
- @icons-pack/react-simple-icons

0 commit comments

Comments
 (0)