Skip to content

Commit db3c4a9

Browse files
authored
Docs/readme updates (#108)
* Update README.md * Update README.md
1 parent f5b8a21 commit db3c4a9

File tree

1 file changed

+48
-5
lines changed

1 file changed

+48
-5
lines changed

README.md

Lines changed: 48 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,58 @@
55
[![Average time to resolve an issue](http://isitmaintained.com/badge/resolution/spinsage/express-typescript-starter-rest.svg)](http://isitmaintained.com/project/spinsage/express-typescript-starter-rest "Average time to resolve an issue")
66
[![Percentage of issues still open](http://isitmaintained.com/badge/open/spinsage/express-typescript-starter-rest.svg)](http://isitmaintained.com/project/spinsage/express-typescript-starter-rest "Percentage of issues still open")
77
[![Gitter chat](https://badges.gitter.im/gitterHQ/gitter.png)](https://gitter.im/spinsage/community)
8+
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
89

910
# Express (Typescript) Rest API Starter
11+
1012
Boilerplate project for bootstrapping development of a Rest API application with Express using Typescript as the programming language.
1113

12-
# LICENSE
13-
**Express Rest API Starter** is Apache 2-licensed.
14-
<br><br>
14+
## Getting Started
15+
16+
### Clone the repository
17+
18+
```console
19+
git clone https://github.com/spinsage/express-typescript-starter-rest.git
20+
```
21+
22+
### Install dependencies
23+
24+
```console
25+
npm install
26+
```
27+
28+
### Configure environment variables
29+
30+
- Create a .env file by copying .env.sample.
31+
- Update environment variable values in the .env file as needed.
32+
33+
### Run the application
34+
35+
#### For development
36+
37+
```console
38+
npm run dev
39+
```
40+
41+
#### For deployment
42+
43+
```console
44+
npm run build
45+
npm run start
46+
```
47+
48+
#### Within a Docker container
49+
50+
```console
51+
docker-compose up
52+
```
53+
54+
## LICENSE
55+
56+
**Express Rest API Starter** is Apache 2-licensed.
57+
58+
## Let us know!
1559

16-
# Let us know!
17-
We at [**Spinsage**](https://www.spinsage.com/) would be happy if you send us links to your projects where you are using our code. Just send us an email at [email protected].
60+
We at [**Spinsage**](https://www.spinsage.com/) would be happy if you send us links to your projects where you are using our code. Just send us an email at [email protected].
1861

1962
And do let us know if you have any queries or suggestions regarding our work.

0 commit comments

Comments
 (0)