https://github.com/amoghmadan/typescript-express-rest-starter
Kick-starter to your REST application.
https://github.com/amoghmadan/typescript-express-rest-starter
docker express jest mongoose node rest-api supertest typescipt
Last synced: about 1 month ago
JSON representation
Kick-starter to your REST application.
- Host: GitHub
- URL: https://github.com/amoghmadan/typescript-express-rest-starter
- Owner: amoghmadan
- License: mit
- Created: 2020-03-25T12:03:59.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2024-06-16T11:44:35.000Z (12 months ago)
- Last Synced: 2025-05-07T05:06:29.807Z (about 1 month ago)
- Topics: docker, express, jest, mongoose, node, rest-api, supertest, typescipt
- Language: TypeScript
- Homepage: https://github.com/amoghmadan/TypeScript-Express-REST-Starter
- Size: 351 KB
- Stars: 7
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# TypeScript-Express-REST-Starter
Kick-starter to your REST application.
`Node`, `Express`, `MongoDB`, `CLI` and more.
## Introduction
The project is a skeleton for an experss application and the way I like to configure it.
This structure is in no way a perfect fit all the projects, but might be a great fit for most big applications.
It contains login, logout and details for accounts, using custom token generation. The CLI provides user creation using commands and password change functionality as well.
## How to setup?
- Clone this project. PS: Delete the package-lock.json. You might want to rename the name & author in package.json and maintainer in Dockerfile.
- Run: -
```bash
npm i --location=project
```
- Add an environemnt file `.env` to the root of the project and set your MONGODB_URI. Typically: -
```
MONGODB_URI = mongodb://127.0.0.1:27017/
```
- Create an admin user: -
```bash
npm run dev createsuperuser
```
- Run the development server: -
```bash
npm run dev bootstrap
```