Skip to content

Commit 27fccab

Browse files
committed
docs: 📚 readme init
1 parent 3437426 commit 27fccab

File tree

1 file changed

+51
-2
lines changed

1 file changed

+51
-2
lines changed

README.md

Lines changed: 51 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,51 @@
1-
# api_server_boilerplate
2-
typescript + typeorm + github action + docker + sentry
1+
<h1 align="center">Welcome to api_server_boilerplate 👋</h1>
2+
<p>
3+
<img alt="Version" src="https://img.shields.io/badge/version-1.0.0-blue.svg?cacheSeconds=2592000" />
4+
<a href="https://github.com/Q00/api_server_boilerplate/blob/development/README.md" target="_blank">
5+
<img alt="Documentation" src="https://img.shields.io/badge/documentation-yes-brightgreen.svg" />
6+
</a>
7+
<a href="#" target="_blank">
8+
<img alt="License: MIT" src="https://img.shields.io/badge/License-MIT-yellow.svg" />
9+
</a>
10+
</p>
11+
12+
> easy to use typescript express boilerplate. You can use board api, user api, error tracking etc..
13+
14+
### 🏠 [Homepage](https://github.com/Q00/api_server_boilerplate/blob/development/README.md)
15+
16+
## Install
17+
18+
```sh
19+
yarn install
20+
```
21+
22+
## Usage
23+
24+
```sh
25+
yarn dev
26+
```
27+
28+
## Run tests
29+
30+
```sh
31+
yarn prepare
32+
```
33+
34+
## Author
35+
36+
👤 **Q00 <[email protected]>**
37+
38+
- Website: https://velog.io/@q00
39+
- Github: [@Q00](https://github.com/Q00)
40+
41+
## 🤝 Contributing
42+
43+
Contributions, issues and feature requests are welcome!<br />Feel free to check [issues page](https://github.com/Q00/api_server_boilerplate/issues).
44+
45+
## Show your support
46+
47+
Give a ⭐️ if this project helped you!
48+
49+
---
50+
51+
_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_

0 commit comments

Comments
 (0)