Skip to content
This repository was archived by the owner on Sep 9, 2024. It is now read-only.

Main #178

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

Main #178

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
18 changes: 6 additions & 12 deletions DEVELOPERS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,19 +54,13 @@ To contribute code to Ocular, you must fork the [Ocular repo](https://github.com
turbo build
```

2. Copy the example `env.dev.example` to `.env.dev`

```sh
cp env.dev.example packages/ocular/.env.dev
```

3. Navigate to Ocular Dir
2. Navigate to Ocular Dir
Copy link
Contributor

@Vivek-Lahole Vivek-Lahole Aug 23, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more. 

     cp env.dev.example packages/ocular/.env.dev

this command copy the required file to ocular directory

Copy link
Author

@ttafuma ttafuma Aug 28, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

env.dev.example does not exist


```sh
cd packages/ocular/
```

4. Configure .env with app and plugin secrets of the apps and plugins you want to connect.
3. Configure .env with app and plugin secrets of the apps and plugins you want to connect.

- Azure Keys are **required** since they allow Ocular to connect to an LLM Service

Expand All @@ -81,13 +75,13 @@ To contribute code to Ocular, you must fork the [Ocular repo](https://github.com

- Additional ApiKeys for other apps are optionnal but needed if you intend to connect Ocular to other apps.

5. Run Postgress DB + Redis + QDrant in Docker
4. Run Postgress DB + Redis + QDrant in Docker

```sh
docker compose -f docker-compose.dev.yml up
```

6. Start the backend.
5. Start the backend.

```sh
npm run dev # start the backend
Expand All @@ -98,7 +92,7 @@ To contribute code to Ocular, you must fork the [Ocular repo](https://github.com
1. Navigate to Ocular UI in "packages/ocular-ui".

```sh
cd packages/ocular/
cd packages/ocular-ui/
```

2. Install front end dependencies with the following command.
Expand Down Expand Up @@ -208,4 +202,4 @@ We don't have a process for assigning issues to contributors yet.

## Community channels

If you get stuck somewhere or have any questions, join our [Slack Workspace](https://join.slack.com/t/ocular-ai/shared_invite/zt-2g7ka0j1c-Tx~Q46MjplNma2Sk2Ruplw)!
If you get stuck somewhere or have any questions, join our [Slack Workspace](https://join.slack.com/t/ocular-ai/shared_invite/zt-2g7ka0j1c-Tx~Q46MjplNma2Sk2Ruplw)!