Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/heanzyzabala/create-express-api
A template generator for creating RESTful API using Express + Typescript + TypeORM
https://github.com/heanzyzabala/create-express-api
express jest node supertest typeorm typescript
Last synced: 11 days ago
JSON representation
A template generator for creating RESTful API using Express + Typescript + TypeORM
- Host: GitHub
- URL: https://github.com/heanzyzabala/create-express-api
- Owner: heanzyzabala
- License: mit
- Created: 2020-08-04T15:46:31.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-01-24T05:31:01.000Z (almost 2 years ago)
- Last Synced: 2024-08-10T11:32:25.214Z (3 months ago)
- Topics: express, jest, node, supertest, typeorm, typescript
- Language: TypeScript
- Homepage:
- Size: 1.33 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# create-express-api
A template generator for a restful node project.
This project mainly uses [Express](https://expressjs.com), [Typescript](https://www.typescriptlang.org) and [TypeORM](https://typeorm.io/).
## Installation
You can clone this repository:
```bash
git clone https://github.com/heanzyzabala/create-express-api.git
```
or you can install the module [@hzabala/create-express-api](https://www.npmjs.com/package/create-express-starter) available in npm.
```bash
npm i -g @hzabala/create-express-api
```
## Usage
Create a project using the command:
```bash
create-express-api myapp
```
This command clones the repository and perform a cleanup (remove .git, bin, etc.) just to detach any information of the cloned repository from the creator.
Start the project in dev mode:
```bash
cd myapp
npm run dev
```
## Contributing
Pull requests are welcome. Please open an issue first to discuss what you would like to change.
## License
```
MIT License
Copyright (c) 2021 Heanzy Zabala
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```