Skip to content

Commit 70871cc

Browse files
authored
Update README.md
1 parent 23ccedc commit 70871cc

File tree

1 file changed

+6
-58
lines changed

1 file changed

+6
-58
lines changed

es6-example/README.md

Lines changed: 6 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -1,62 +1,10 @@
1-
# Nodejs-ES6-Boilerplate
2-
[![Made in Indonesia](https://made-in-indonesia.github.io/made-in-indonesia.svg)](https://github.com/made-in-indonesia/made-in-indonesia)
1+
<img width="100%" src="https://github.com/Flagsmith/flagsmith/raw/main/static-files/hero.png"/>
32

4-
A Node.js boilerplate with ES6, ESLint, and Prettier
3+
# Flagsmith Node.js example with custom fetch agent
54

6-
## Background
5+
This is a simple Flagsmith Node.js example in local evaluation modes with a custom fetch agent. Using a custom fetch agent lets allows you to specify networking related options such as keep alive and socket timeout, read more on this [here](https://github.com/node-fetch/node-fetch#custom-agent).
76

8-
I created this boilerplate because I have several coding interviews that needs to be done using JavaScript.
9-
10-
## Scripts
11-
12-
```bash
13-
# Run the project without nodemon
14-
npm run start
15-
16-
# Build the project
17-
npm run build
18-
19-
# Clean build
20-
npm run clean
21-
22-
# Check the lint errors
23-
npm run lint
24-
25-
# Fix the lint errors
26-
npm run lint:fix
27-
28-
# Run prettier
29-
npm run format
30-
31-
# Check prettier errors
32-
npm run format:check
33-
```
34-
35-
## Usage
36-
37-
1. Clone the repository and init new git project
38-
39-
```bash
40-
$ git clone [email protected]:vferdiansyah/nodejs-es6-boilerplate.git ./your/project/folder
41-
$ cd ./your/project/folder
42-
$ rm -rf .git
43-
$ git init
44-
```
45-
46-
2. Change project specific information in the following places
47-
48-
- [package.json](./package.json)
49-
- [README.md](./README.md)
50-
51-
3. Install dependencies
52-
53-
```bash
54-
$ npm i
7+
```shell
8+
npm i
9+
npm run dev
5510
```
56-
57-
4. Start coding
58-
59-
## License
60-
61-
Copyright (c) 2020 Veri Ferdiansyah
62-
Licensed under the MIT license.

0 commit comments

Comments
 (0)