Skip to content

Dev #9

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

Merged
merged 2 commits into from
Mar 7, 2025
Merged

Dev #9

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4dd82a0
update README
htnabe Mar 7, 2025
9ffced4
Merge pull request #8 from htnabe/feature/README
htnabe Mar 7, 2025
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
50 changes: 44 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,18 @@

This is a command-line util to upload Algolia sources. This idea comes from [atomic-algolia](https://github.com/chrisdmacrae/atomic-algolia).

## Install

```
npm install -D algolia-uploader
```

or

```
yarn add -D algolia-uploader
```

## Example

1. Make `.env` file and set params
Expand All @@ -13,8 +25,23 @@ This is a command-line util to upload Algolia sources. This idea comes from [ato
DATA_DIR=path/to/dir
```

| | Description |
| --------------------- | ------------------------------------------------------------------------------------- |
| ALGOLIA_APP_ID | ID of the app indexed in Algolia |
| ALGOLIA_ADMIN_API_KEY | API key that can update, delete and make indexes |
| ALGOLIA_INDEX_NAME | Name of index set inn Algolia |
| DATA_DIR | Relative path to the directory where the file you want to upload to Algolia is stored |

> [!IMPORTANT]
> Do not include the file name in `DATA_DIR`.

2. Make `example.json` to be uploaded to Algolia

> [!CAUTION]
>
> - Currently only json file is supported.
> - `objectID` key is necessary

```
[
{
Expand Down Expand Up @@ -50,21 +77,32 @@ This is a command-line util to upload Algolia sources. This idea comes from [ato
]
```

Cautions:
3. Execute command

- `objectID` is necessary
- For now, only one json file can be loaded, I will support multiple files(maybe)
For example,

3. Run `npx algolia-uploader` (WIP)
```
npx algolia-uploader
```

If this library is published, I will try to make it possible to do the following
```
npm run algolia-uploader
```

```
> npx algolia-uploader
yarn algolia-uploader
```

Then, the items will be uploaded.

```
> Added 3 items
> Updated 2 items
> Deleted 3 items

or

> No updates needed. All objects are up to date.
```

## Development
Expand Down