https://github.com/nelsonwenner/node-typescript-api-auth
:closed_lock_with_key: Node typescript api auth
https://github.com/nelsonwenner/node-typescript-api-auth
authentication docker docker-compose express jest mogodb nodejs swagger tests typescript
Last synced: 3 months ago
JSON representation
:closed_lock_with_key: Node typescript api auth
- Host: GitHub
- URL: https://github.com/nelsonwenner/node-typescript-api-auth
- Owner: nelsonwenner
- License: mit
- Created: 2020-11-14T15:01:18.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-11-16T18:24:54.000Z (over 5 years ago)
- Last Synced: 2025-10-27T05:16:27.445Z (8 months ago)
- Topics: authentication, docker, docker-compose, express, jest, mogodb, nodejs, swagger, tests, typescript
- Language: TypeScript
- Homepage:
- Size: 307 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
NODE TYPESCRIPT API AUTH
## :rocket: Technologies
* [Typescript](https://www.typescriptlang.org/)
* [NodeJS](https://nodejs.org/en/)
* [Mongo](https://www.mongodb.com/)
* [Docker](https://www.docker.com/)
## :electric_plug: Prerequisites
- [NodeJS LTS (>= 12.x)](https://nodejs.org/)
- [Docker (>= 19.03.x)](https://docs.docker.com/engine/install/ubuntu/)
- [Docker Compose (>= 1.05.x)](https://docs.docker.com/compose/install/)
## :information_source: Getting Started
1. Fork this repository and clone it on your machine.
2. Change the directory to `node-typescript-api-auth` where you cloned it.
## :whale2: Docker Getting Started
```shell
/* Run docker */
$ docker-compose up -d
/* Down docker */
$ docker-compose down
```
## :closed_lock_with_key: Backend Getting Started
```shell
/* Create `.env` of the system */
$ cp .env.example .env
/* Install dependencies */
$ npm install
/* Run the development server /*
$ npm run dev
/* Run the production server /*
$ npm run start
```
* Open backend, the host [localhost:3333](http://localhost:3333)
## :spiral_notepad: Swagger
To access the API documentation, with the server running, access [http://localhost:3333/docs](http://localhost:3333/docs)
## :memo: License
This project is under the MIT license. See the [LICENSE](LICENSE.md) for more information.
---