Skip to content

Commit 1d14e51

Browse files
authored
Update README.md
1 parent 9471d3e commit 1d14e51

File tree

1 file changed

+12
-10
lines changed

1 file changed

+12
-10
lines changed

README.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
1-
# CREATE-EXPRESS-TEMPLATE
1+
# CREATE-EXPRESS-TEMPLATE [![Build Status](https://travis-ci.org/dopecodez/create-express-template.svg?branch=master)](https://travis-ci.org/dopecodez/create-express-template) [![Contributions](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/dopecodez/create-express-template/issues)
22

3-
Create a modern express server with a simple command.
3+
Create a modern express server with a single command.
44

55
![Working sample](https://media.giphy.com/media/MC9h5ruPM0Wk7lJyxQ/giphy.gif)
66

7+
Scale a development ready server in one step.
8+
79
Works on macOS, Windows, and Linux. Has both TypeScript and JavaScript templates inbuild. Creates all the boilerplate code along with build process and unit tests configured so that you can focus on the application logic.
810

911
Optionally, add the ORM for database support and also configure dependency injection.
@@ -18,7 +20,7 @@ $ npm start
1820

1921
We strongly suggest using npx from for npm versions 5.2+. You can also install create-express-template globally and use it to create a template anywhere in your system.
2022

21-
After starting, go to http://localhost:3000/ to see a simple page(3000 here being the port number, you can change this in the .env file). We also implement a sample route at http://localhost:3000/api/v1/users so you can start building immediately following the pattern.
23+
After running `npm start`, go to http://localhost:3000/ to see a simple page(3000 here being the port number, you can change this in the .env file). We also implement a sample route at http://localhost:3000/api/v1/users so you can start building immediately following the pattern.
2224

2325
## Highlights
2426

@@ -44,11 +46,11 @@ $ npx create-express-template --help
4446
--yarn(-y) Use Yarn
4547
4648
Examples
47-
$ create-express-app
48-
$ create-express-app my-app
49-
$ create-express-app my-app -d
50-
$ create-express-app my-app --template=TypeScript-Inversify-TypeORM -y
51-
$ create-express-app my-app --template=tsti -y
49+
$ create-express-template
50+
$ create-express-template my-app
51+
$ create-express-template my-app -d
52+
$ create-express-template my-app --template=TypeScript-Inversify-TypeORM -y
53+
$ create-express-app my-template --template=tsti -y
5254
5355
```
5456

@@ -73,15 +75,15 @@ The available templates(you can use the full names or the initials) are listed [
7375

7476
**Note : The `template` option can take any of these template values or their initials.**
7577

76-
We use [Sequelize](https://sequelize.org) for JavaScript and [TypeORM](https://typeorm.io/#/) for TypeScript and both are excellent ORMs. You can check out their pages for more information on creating models and writing queries.
78+
We use [Sequelize](https://sequelize.org) for JavaScript and [TypeORM](https://typeorm.io/#/) for TypeScript and both are excellent ORMs. You can check out their pages for more information on creating models and writing queries. There is a sample model structure created so that you can follow the pattern and start building your models directly.
7779

7880
[Inversify](https://github.com/inversify/InversifyJS) is an excellent and lightweight inversion of control container for JavaScript & Node.js apps powered by TypeScript. For people unfamiliar with why you would want to have [Inversion of control](https://medium.com/@amitkma/understanding-inversion-of-control-ioc-principle-163b1dc97454), this one and many other articles can be found on the topic. Read up more on [Dependency Injection](https://www.freecodecamp.org/news/a-quick-intro-to-dependency-injection-what-it-is-and-when-to-use-it-7578c84fa88f/) and why and when you should use it to understand why `inversify` helps in building modern applications.
7981

8082
## Under The Hood
8183

8284
Internally, there are several things being setup in the templates. We use a module structure to separate our components, but you can change this if you want to.
8385

84-
The unit tests are configured using [ava](https://github.com/avajs/ava), and all the templates come configured with at least one unit test. For logging, we use [Winston](https://github.com/winstonjs/winston) for its ease of use. The logging setup is currently very basic, and will log errors and info in two separate files.
86+
The unit tests are configured using [ava](https://github.com/avajs/ava), and all the templates come configured with at least one unit test. You can expand these tests using the sample structure provided or remove them completely if you want to. For logging, we use [Winston](https://github.com/winstonjs/winston) for its ease of use. The logging setup is currently very basic, and will log errors and info in two separate files.
8587

8688
We also have `cors` enabled so as not to have errors. We use [eslint](https://eslint.org/) to maintain best coding practices. This can be hugely helpful if you want to maintain certain coding standards within your application.
8789

0 commit comments

Comments
 (0)