https://github.com/anychart/reference-engine
https://github.com/anychart/reference-engine
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/anychart/reference-engine
- Owner: AnyChart
- Created: 2014-09-15T02:46:16.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2025-03-27T17:18:54.000Z (about 1 year ago)
- Last Synced: 2025-03-27T17:41:40.816Z (about 1 year ago)
- Language: Clojure
- Size: 3.88 MB
- Stars: 1
- Watchers: 19
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[
](https://anychart.com)
# AnyChart API Reference Engine
[AnyChart API Reference](https://api.anychart.com) is a place where users
can find a detailed description of each
namespace, class, method or property, along with ready-to-try samples.
The application consists of two parts: the web part and the generator.
The Web part is just a site responsible for displaying the content, and the generator
is a parser whose main task is to parse the
[corresponding repository](https://github.com/AnyChart/api.anychart.com).
There are all AnyChart namespaces described in JsDoc format in that repository.
The application backend is written on Clojure and the frontend on Javascript with jQuery.
[](https://travis-ci.com/AnyChart/reference-engine)
[Production](http://api.anychart.com)
[](https://travis-ci.com/AnyChart/reference-engine)
[Staging](http://api.anychart.stg)
## Set up
```
1. Put api.anychart.com repository to data/repo folder
2. Set nginx to route: data/versions-static -> http://domain/si
3. Set up ts-tests to data/ to check TypeScript index.d.ts
```
## Install dependencies
```
# to build js
sudo apt-get install closure-compiler
sudo npm install -g jsdoc
sudo ln -s /usr/bin/jsdoc /usr/local/bin/jsdoc
```
## Setup local database
The application uses PostgreSQL, so you need to create database and user:
```
sudo -u postgres psql
CREATE USER reference_user WITH PASSWORD 'pass';
CREATE DATABASE reference_db;
GRANT ALL PRIVILEGES ON DATABASE reference_db TO reference_user;
\c reference_db
# create scheme
```
## License
If you have any questions regarding licensing - please contact us.