Skip to content

Commit

Permalink
undefined now converting to null by parser
Browse files Browse the repository at this point in the history
  • Loading branch information
Andcool-Systems committed Dec 22, 2024
1 parent 5f16af4 commit c16cafc
Show file tree
Hide file tree
Showing 8 changed files with 8,864 additions and 8,857 deletions.
2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ RUN npm i

RUN npm run build

CMD [ "npm", "run", "start" ]
CMD [ "npm", "run", "start:prod" ]
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
# JSON Stats Widget
Виджет для профиля GitHub, выполненный в стиле редактора кода VSCode.

## Описание
Важной отличительной чертой этого проекта является **парсер JavaScript объектов в формат `svg`**. Благодаря нему виджет может отображать JSON любой структуры и вложенности (насколько этого позволяет глубина рекурсии NodeJS). Каждый запрос на получение виджета генерирует SVG код <u>на лету</u>, кешируя только запросы к сторонним API.

## Конфигурация
Так как объем настроек слишком большой, на данный момент не предоставляется возможности публичного использования, поэтому если вы хотите настроить такое виджет под себя, то вам придется размещать его на своем сервере.
### Базовая конфигурация
Так как объем настроек слишком большой, на данный момент не предоставляется возможности публичного использования, поэтому если вы хотите настроить такой виджет под себя, то вам придется размещать его на своем сервере.

Все параметры находятся в `.env` файле в корне проекта.

Expand Down Expand Up @@ -34,6 +38,9 @@ DATETIME_TIMEZONE="Etc/GMT-3" // Yours timezone

- `DATETIME_TIMEZONE` – Часовой пояс в формате JavaScript Date.

### Конфигурация генерации SVG
Вы также можете настроить стиль, отступы и другие параметры генерации SVG в файле [config.ts](https://github.com/Andcool-Systems/json-stats/blob/master/src/config.ts).
Все функции, представленные в этом конфигурационном файле вызываются **при каждой** генерации SVG.
## Быстрый старт
Для начала работы клонируйте этот репозиторий, создайте `.env` файл с конфигурацией и запустите Docker контейнер.
```bash
Expand Down
2 changes: 1 addition & 1 deletion docker-compose.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ services:
networks:
- nginx
restart: unless-stopped
command: npm run start
command: npm run start:prod

networks:
nginx:
Expand Down
Loading

0 comments on commit c16cafc

Please sign in to comment.