Skip to content

Commit

Permalink
Update README.ms file
Browse files Browse the repository at this point in the history
  • Loading branch information
math121 committed Nov 7, 2024
1 parent 613e15f commit 8aba692
Showing 1 changed file with 44 additions and 0 deletions.
44 changes: 44 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,46 @@
# MarkusAI-frontend

MarkusAI is an office supply management system

## Prerequisites

- [Node.js](https://nodejs.org/en/download/package-manager)
- [npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)

Check if both Node.js and npm are installed by running this command on the terminal:

```bash
npm -v && node -v
```

- Run the backend for the API calls:
https://github.com/masagal/MarkusAI-backend

## Clone project

Use the terminal to clone the frontend project

```bash
git clone https://github.com/masagal/MarkusAI-frontend.git
```

## Install dependencies

cd into the project, and install the dependencies using npm:

```bash
cd MarkusAI-frontend
npm install
```

## Run locally

```bash
npm run dev
```

## Team members

- [Mathangi Pushparajah](https://github.com/math121)
- [Ludvig Fendert](https://github.com/Junotas)
- [Simon Kendall](https://github.com/sighmoan)

0 comments on commit 8aba692

Please sign in to comment.