Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thonatos/shorturl-egg
shorturl powered by egg
https://github.com/thonatos/shorturl-egg
egg shorturl
Last synced: about 2 months ago
JSON representation
shorturl powered by egg
- Host: GitHub
- URL: https://github.com/thonatos/shorturl-egg
- Owner: thonatos
- Created: 2017-07-21T03:21:48.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-04-26T09:37:35.000Z (over 6 years ago)
- Last Synced: 2024-11-01T09:51:36.657Z (2 months ago)
- Topics: egg, shorturl
- Language: JavaScript
- Homepage: https://swz.li
- Size: 692 KB
- Stars: 24
- Watchers: 3
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# shorturl
shorturl powered by egg.js
## QuickStart
see [egg docs][egg] for more detail.
### Development
```shell
$ npm install
$ npm run dev
$ open http://localhost:7001
```
### Deploy
Use `EGG_SERVER_ENV=prod` to enable prod mode
```shell
$ EGG_SERVER_ENV=prod npm start
```
### npm scripts
- Use `npm run lint` to check code style.
- Use `npm test` to run unit test.
- Use `npm run autod` to auto detect dependencies upgrade, see [autod](https://www.npmjs.com/package/autod) for more detail.
### docker-compose
```shell
cd docs/docker-compose
docker-compose up
```
see [docs/docker-compose](https://github.com/thonatos/shorturl-egg/tree/master/docs/docker-compose) for more detail.
## Config
### Database
```
// mysql
DROP TABLE IF EXISTS `url`;
CREATE TABLE `url` (
`id` int(11) NOT NULL AUTO_INCREMENT,
`url` varchar(512) NOT NULL,
`created` datetime DEFAULT CURRENT_TIMESTAMP,
`hash` varchar(512) DEFAULT NULL,
PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=200 DEFAULT CHARSET=utf8mb4;
```
```
// elasticsearch
// geoip configure
PUT _ingest/pipeline/geoip
{
"description" : "Add geoip info",
"processors" : [
{
"geoip" : {
"field" : "ip"
}
}
]
}
// mappings
PUT shorturl
{
"mappings": {
"view": {
"_all": {
"enabled": false
},
"properties": {
"ip": {
"type": "ip"
},
"date": {
"type": "date"
}
}
}
}
}
```
### Application
- app/config/config.prod.js
```js
'use strict';
exports.site = {
domain: 'https://swz.li/',
};
exports.mysql = {
client: {
host: 'mysql',
port: '3306',
user: 'root',
password: 'mysql',
database: 'shorturl',
},
};
exports.redis = {
client: {
port: 6379,
host: 'redis',
password: null,
db: 0,
},
};
exports.elasticsearch = {
host: 'elasticsearch:9200',
};
```
## Api
- POST /api/v1/shorten
```js
// request body
{
"url":"http://www.baidu.com"
}
// response
{
"url": "http://www.baidu.com",
"hash": "QioWY",
"shorturl": "http://localhost:7001/QioWY"
}
```
- GET /api/v1/expand/:hash
```js
{
"id": 2,
"url": "http://www.baidu.com",
"created": "2017-07-24T03:42:06.000Z"
}
```
- GET /api/v1/count
```js
[
{
"id": 2,
"url": "http://www.baidu.com",
"created": "2017-07-24T03:42:06.000Z"
},
{
"id": 1,
"url": "http://www.baidu.com/?test=3",
"created": "2017-07-23T06:56:48.000Z"
}
]
```
[egg]: https://eggjs.org