# IconSpirit

**Repository Path**: code-cola/IconSpirit

## Basic Information

- **Project Name**: IconSpirit
- **Description**: IconSpirit is a vector icon library of corporate intranet Icons developed based on node + vue
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2021-12-02
- **Last Updated**: 2025-07-11

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# [IconSpirit](https://iconspirit.vue2.net)

<div align="center">
  <a href="https://iconspirit.vue2.net">
    <img src="https://f.vue2.net/IconSpiritd-03.jpg" alt="IconSpirit Logo" height="160">
  </a>
</div>

English | [简体中文](README.zh-CN.md)

### Introduction

<a href="https://iconspirit.vue2.net">IconSpirit</a> is an enterprise intranet vector icon library developed based on node + vue, which has absorbed the advantages of Alibaba Cloud Iconfont and Icons8 already on the market. In order to fit the company's intranet deployment or secondary development, IconSpirit has increased the organizational structure and permissions of the corporate team, access to Ldap login, OA query user invitation to join the project. At the same time, it is also suitable for designers to upload svg materials to IconSpirit, the company's intranet, to create a public platform for the company's internal Icons. In addition, in order to facilitate the migration of Alibaba Cloud iconfont fonts to IconSpirit, the css link address can be entered on the project management page, and the migration operation is one-click.

### Icons advantages

1. Generated files: Supports uploading of generated files to Alibaba Cloud oss platform to facilitate CDN acceleration;
2. Quick migration: Support the migration of Alibaba Cloud iconfont fonts to IconSpirit, and generate new IconSpirit projects through de-analysis of css link addresses;
3. Designer material platform: support designers to upload svg material to IconSpirit, the company's intranet, to create an internal public platform for designers' Icons;
4. Interface capability: Support other platforms to call IconSpirit interface. For example, the company's internal low-code platform needs to use the icon icon, and you can directly call the interface to query IconSpirit.

### Deployment
1. Database configuration: IconSpirit needs to configure Redis, MongoDB 4.2+, Alibaba Cloud oss, Ldap link address. The default is to support obtaining configuration data information from consul. (See configuration below)
2. Backend deployment: use node 14+ on the virtual machine and run npm run egg:start to start the back-end server;
3. Front-end deployment: npm run build packaging; configure nginx to map to the corresponding dist directory on the server.

#### MongoDB configuration
Open the config/config.local.js file and find the Redis configuration. Please install MongoDB 4.2 and above.

```javascript
exports.mongoose = {
    client: {
        url: 'mongodb://127.0.0.1:27017/ops-iconfont',
        options: {}
    }
}
```
#### Redis configuration
Open the config/config.local.js file and find the Redis configuration.

```javascript
exports.redis = {
    client: {
      port: 6379,          // Redis port
      host: '127.0.0.1',   // Redis host
      password: 'cc',
      db: 0
    }
}
```
#### Alibaba Cloud oss configuration
The generated font file will eventually be uploaded to the Alibaba Cloud oss warehouse, so you need to find the OSS_local or OSS_fat configuration in app/config/oss_config.js and modify it.

```javascript
const OSS_local =  {
  website: "", //Domain name bound to Alibaba Cloud bucket
  region: "",
  accessKeyId: "",
  accessKeySecret: "",
  bucket: "",
  cname: true,
  path: ""
}
```


##### Ldap configuration
Fill in the corresponding Ldap account information in the app/config/ldap_config.js file.

```javascript
const DEFAULT_CONFIG = {
  ldapOpts: {
    url: '',
  },
  adminDn: "",
  adminPassword: "",
  userSearchBase: "",
  usernameAttribute: "",
  username: '',
  userPassword: '',
}
```