Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/serverless-plus/shorten-urls
Serverless Shorten Urls Service
https://github.com/serverless-plus/shorten-urls
serverless serverless-components shorten-urls
Last synced: 4 months ago
JSON representation
Serverless Shorten Urls Service
- Host: GitHub
- URL: https://github.com/serverless-plus/shorten-urls
- Owner: serverless-plus
- License: mit
- Created: 2020-10-04T04:00:55.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-10-18T13:02:46.000Z (over 4 years ago)
- Last Synced: 2024-08-01T21:47:35.442Z (7 months ago)
- Topics: serverless, serverless-components, shorten-urls
- Language: TypeScript
- Homepage: https://url.sls.plus
- Size: 43 KB
- Stars: 8
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-serverless-framework - shorten-urls - 短连接服务 Express + TypeScript 🚀 (开发模板)
README
# Shorten Urls
[Online](https://url.sls.plus)
[](https://github.com/serverless-plus/shorten-urls/actions?query=workflow:Validate+branch:master)
[](https://github.com/semantic-release/semantic-release)
Serverless shorten urls service using [serverless framework](https://github.com/serverless/serverless).
## Features
- [x] [Serverless Framework](https://github.com/serverless/serverless)
- [x] [Typescript](https://github.com/microsoft/TypeScript)
- [x] [Github Actions](https://github.com/features/actions)
- [x] [Eslint](https://github.com/eslint/eslint)
- [x] [Prettier](https://github.com/prettier/prettier)
- [x] [Jest](https://github.com/facebook/jest)
- [x] [semantic-release](https://github.com/semantic-release/semantic-release)
## Usage
```bash
$ git clone https://github.com/serverless-plus/shorten-urls.git
```
## Development
Install dependencies:
```bash
$ npm install
```
To start server locally, you can start local posgresql by docker and connect to it for development.
Start local docker postgresql:
```bash
$ npm run docker:up
```
Then copy `.env.example` to `.env`:
```bash
$ cp .env.example .env
```
Run server:
```bash
$ npm run dev
```
## Deployment
Before deployment, you should build project:
```bash
$ npm run build
```
Then you can deploy relative resources, after the first deployment, below step is optional for next time.
### Deploy database
Serverless PostgreSQL need `VPC`, so we need create a `VPC` for it:
```bash
$ npm run deploy:vpc
```
Then we can deploy database:
```bash
$ npm run deploy:db
```
### Deploy layer
For nodejs project, we can deploy `node_modules` directory to layer, so after first deployment, we do not need to deploy `node_modules` directory again, this is very useful to make our source code deployment quickly.
To make layer code smaller, we can run:
```bash
$ rm -rf node_modules && npm install --production
```
so we just deploy npm modules of production to layer,
```bash
$ npm run deploy:layer
```
> **Notice**: after layer deployment, if you do not change npm modules for production, you don't need to deploy layer.
### Deploy static files
Upload static files in `public` directory to COS:
```bash
$ npm run deploy:cos
```
### Deploy server code
```bash
$ npm run deploy
```
### Commit Lint
All `git commit` mesage must follow below syntax:
```bash
type(scope?): subject #scope is optional
```
support type：
- **feat**: add new feature
- **fix**: fix bug or patch feature
- **ci**: CI
- **chore**: modify config, nothing to do with production code
- **docs**: create or modifiy documents
- **refactor**: refactor project
- **revert**: revert
- **test**: test
Most of time, we just use `feat` and `fix`.
## License
MIT License
Copyright (c) 2020 Serverless Plus