Skip to content

Commit

Permalink
small changes to get-started section
Browse files Browse the repository at this point in the history
  • Loading branch information
DonKoko committed Sep 19, 2024
1 parent fc35850 commit c9e11e7
Showing 1 changed file with 21 additions and 12 deletions.
33 changes: 21 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Shelf is ideal for managing:
- **IT Asset Management**: Track devices, peripherals, and office technology.
- **Theatre & Arts**: Perfect for managing props, costumes, and scenic elements for productions.
- **Home Inventory**: Organize and track personal items, manage warranties, and know their locations.
- **Educational Institutions**: Centralize and manage department assets for better collaboration.
- **Educational Institutions**: Centralize and manage department assets for **better** collaboration.

---

Expand All @@ -63,18 +63,27 @@ Shelf is ideal for managing:
To set up Shelf:

1. **Clone the Repo**:
```bash
git clone https://github.com/Shelf-nu/shelf.nu.git
cd shelf.nu
```
```bash
git clone https://github.com/Shelf-nu/shelf.nu.git
cd shelf.nu
```
2. **Install Dependencies**:
```bash
npm install
```
3. **Run Locally**:
```bash
npm run dev
```
```bash
npm install
```
3. **Setup your database:**

- Create your supabase database: [Guide](./docs/get-started.md#development)
- Run intial migrations

```
npm run setup
```

4. **Start local server**:
```bash
npm run dev
```

For detailed setup instructions, check out our [documentation](https://github.com/Shelf-nu/shelf.nu/tree/main/docs).

Expand Down

0 comments on commit c9e11e7

Please sign in to comment.