Skip to content

readme file updation #36

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Ashrithhn wants to merge 1 commit into
base: main
Choose a base branch
from
Open

readme file updation #36

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,31 @@ docker compose up --build
```
Now you are ready to visit [api-guidelines](https://github.com/atithi4dev/veren/blob/main/Docs/API_DOCUMENTATION.md) to access the differnt routes and supported features.

## Frontend Setup -

**Prerequisites:**

- **Node.js:** 20.x
- **Package manager:** npm 10.8.2 (or newer 10.x)

**Install and run the frontend locally:**

```bash
cd frontend
npm install
npm run dev
```

**Environment variables:**

- No frontend environment variables are required for local development by default.

**Local development URL:**

- http://localhost:5173

For more frontend details, see [frontend/README.md](frontend/README.md).

## Architecture Overview -

**VEREN** is built as a cloud-native, backend-first deployment platform using a service-oriented architecture:
Expand Down