Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mahabubx7/exts-atom
minimal-starter-repo-expressjs-typescript
https://github.com/mahabubx7/exts-atom
Last synced: 1 day ago
JSON representation
minimal-starter-repo-expressjs-typescript
- Host: GitHub
- URL: https://github.com/mahabubx7/exts-atom
- Owner: mahabubx7
- License: mit
- Archived: true
- Created: 2023-06-06T14:42:53.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-06-06T19:33:05.000Z (over 1 year ago)
- Last Synced: 2024-11-14T14:19:32.371Z (1 day ago)
- Language: TypeScript
- Size: 124 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ex-ts
The minimal expressjs and typescript project starter from scratch. It can be used for learning api development from beggining, making tutorials, R&D or practices.
Also, junior developers can get started to build APIs easily without the hasle for setup project first.
> For @typescript/eslint, typescript version should not be later than 5.1.0 right now. I have chosen v5.0.4
**This repository is for all OS users. We are using `LF` for all.**
```yaml
Node: v18.16.0 (LTS) or later
TypeScript: v5.0.4 [for @typescript/eslint compatibility]
```
### Clone this or use Template
To clone this repository,
```bash
$ git clone [email protected]:mahabubx7/ex-ts.git
```
To use this ready-mate template, you need click on the `Use this template` green button.
### Start Developing
- First, you need to install packages.
```bash
$ npm install
```
or
```bash
$ yarn install
```
- Copy the `.sample.env` file to `.env`.
```bash
$ cp .sample.env .env
```
- To start the development server
```bash
$ npm run dev
```
or
```bash
$ yarn dev
```
- To build this application
```bash
$ npm run build
```
or
```bash
$ yarn build
```
- To run the production mode or build server
```bash
$ npm run start
```
or
```bash
$ yarn start
```
> Make your entire application is wrapped inside the `src` directory. Because, this project will build from that folder only.