Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/eoguvo/auth-node

An simple authentication app built with node.js and typescript
https://github.com/eoguvo/auth-node

auth techs typescript

Last synced: about 2 months ago
JSON representation

An simple authentication app built with node.js and typescript

Awesome Lists containing this project

README

        


header auth node



author - Gustavo Henrique

GitHub stars



language - PortuguΓͺs


Auth-node


An simple authentication app built with node.js and typescript




πŸŽ‰ Auth-node 1.0 πŸš€ Ready! πŸŽ‰


Table of contents
=================

* [Running](#rodando)
* How to use
* [Prerequisites](#pre-requisitos)
* [Installing](#install)
* [Techs](#techs)


🎲 Running



Prerequisites


> Before start, you need have installed in your machine:
[Git](https://git-scm.com), [Node.js (npm)](https://nodejs.org/en/) and [Docker-compose](https://docs.docker.com/compose/install/).
> In addition, it is good to have an editor to work on the code, such as [VSCode](https://code.visualstudio.com/).



follow those steps to install:


```bash
# clone the repository in your machine
$ git clone https://github.com/Gustavo-Henrique-br/Auth-node.git

# Install the dependencies:
$ yarn
# or
$ npm install

# Setup database
$ docker-compose up

# Rename the file .env.example to .env

# Optional: generate public and private keys
$ openssl genrsa -out rsa.private 1024
$ openssl rsa -in rsa.private -out rsa.public -pubout -outform PEM
# Copy the content of the files to .env, see examples in .env.example

# Running in dev mode
$ yarn dev
# or
$ npm run dev

# Just building
$ yarn build
# or
$ npm run build
```


πŸ›  Technologies


- [Nodejs](https://nodejs.org/en/docs/)
- [Express](https://expressjs.com/)
- [TypeScript](https://www.typescriptlang.org/)
- [Bcrypt](https://www.npmjs.com/package/bcrypt)
- [JWT](https://jwt.io/introduction)
- [Joi](https://joi.dev/api/)
- [node-postgres](https://node-postgres.com/)