https://github.com/devsazal/backend-password-validator
Password Validator API & batch-validation with CLI script (TypeScript, Node.js, Express.js)
https://github.com/devsazal/backend-password-validator
docker expressjs mysql nodejs rest-api typescript
Last synced: 9 months ago
JSON representation
Password Validator API & batch-validation with CLI script (TypeScript, Node.js, Express.js)
- Host: GitHub
- URL: https://github.com/devsazal/backend-password-validator
- Owner: DevSazal
- Created: 2023-02-11T11:00:30.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-02-21T17:09:59.000Z (about 3 years ago)
- Last Synced: 2025-07-20T02:01:53.296Z (9 months ago)
- Topics: docker, expressjs, mysql, nodejs, rest-api, typescript
- Language: TypeScript
- Homepage:
- Size: 3.12 MB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Password Validator
### Requirements:
* Node.js (14.x)
* NPM
* TypeScript
* Git
* Docker - [Install Docker community edition](https://hub.docker.com/search/?type=edition&offering=community) optional.
#### 🎁 If you are a fan of docker, then pull the [docker image](https://hub.docker.com/r/sazal/typescript-password-validator) by following the commands:
```bash
docker pull sazal/typescript-password-validator
```
Let's clone the repository on your machine.
The application includes the following files and folders.
- `src` - Code for the application written in TypeScript, Express.js.
- `cli` - Node cli script which can be performed from terminal.
- `__tests__` - to test all the features.
- `.env.example` - A sample of .env which can be helpful for configuration.
## Installation and Configuration
Let's move to the cloned directory with your terminal.
To install, build, and start the application for the first time, run the following commands in your shell using `makefile` (only for macOS and Linux):
```bash
make install
```
Let's rename from `.env.example` to `.env` and make sure all the necessary information is correct:
```bash
PORT=3000
DB_HOST=localhost
DB_PORT=
DB_DATABASE=
DB_USER=
DB_PASSWORD=
```
Already done? Cool! You are almost ready to enjoy the app. ⛳️
### Build:
```
make build
```
### Run:
```bash
make start
```
### Test:
```bash
make test
make test-unit
```
### cli:
Oh! You want to try the application cli feature from terminal
```bash
make node-cli
```
### lint:
```
make lint
```
### lintfix:
```
make lintfix
```
#### 🎯 I know, you liked it.
To learn more, you can use the following commands:
```
make help
```
#### At the same time, you can use the default `npm` commands like:
```bash
npm i
npm run build
npm run start
npm run cli
```
#### 🥇 Congrats!! You are good to go
#### tada! 🎉