https://github.com/librity/ignite_accounts
Rocket Seat - Ignite - NodeJS - Challenge 4 - A user accounts API made with NodeJS and Express.
https://github.com/librity/ignite_accounts
authentication challenge express nodejs rocketseat-ignite
Last synced: 3 months ago
JSON representation
Rocket Seat - Ignite - NodeJS - Challenge 4 - A user accounts API made with NodeJS and Express.
- Host: GitHub
- URL: https://github.com/librity/ignite_accounts
- Owner: librity
- Created: 2021-03-22T07:54:01.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-02-25T11:58:07.000Z (over 4 years ago)
- Last Synced: 2025-01-08T07:39:09.403Z (over 1 year ago)
- Topics: authentication, challenge, express, nodejs, rocketseat-ignite
- Language: TypeScript
- Homepage:
- Size: 106 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Rocket Seat Ignite - User Account Backend
## Table of Contents
- [About](#about)
- [Getting Started](#getting_started)
- [Endpoints](#endpoints)
- [Resources](#resources)
A user account backend made with NodeJS, Express and Jest.
### Prerequisites
- `node >= 12.0.0`
- `yarn >= 1.22.0`
### Installing
1. Clone this repo locally and install the required packages:
```bash
$ git clone https://github.com/librity/ignite_accounts.git
$ cd ignite_accounts
$ yarn install
```
2. Start a dev server:
```bash
$ yarn dev
```
3. Import the Insomnia workspace from `./insomnia/workspace.json`
and run some requests.
### Testing
Run tests with jest:
```bash
$ yarn test
```
`Documentation web UI`
- http://localhost:3333/api-docs
`Users`
- `GET` http://localhost:3333/users
- `GET` http://localhost:3333/users/:id
- `POST` http://localhost:3333/users
- `PATCH` http://localhost:3333/users/:id/admin
- https://github.com/scottie1984/swagger-ui-express
- https://swagger.io/specification/
- https://stackoverflow.com/questions/154059/how-can-i-check-for-an-empty-undefined-null-string-in-javascript