Skip to content
This repository has been archived by the owner on Jul 19, 2022. It is now read-only.

HenriqueSilverio/fullstack

Repository files navigation

Dependabot Status

Full-Stack JavaScript

Requirements

Usage

1. Clone to your machine, and cd into it:

git clone https://github.com/HenriqueSilverio/fullstack.git && cd fullstack

2. Install project dependencies:

npm i

3. Create a .env from .env.sample:

cp .env.sample .env

4. Set JWT_SECRET environment variable:

JWT_SECRET="your-super-secret-key-here"

There are two commands available:

  • npm start: Start server with Nodemon to development and debug.
  • npm test: Runs Mocha tests suite.

REST API

Verb URI Description
POST /api/v1/login User authentication
POST /api/v1/users User sign up
GET /api/v1/users Users list (admin's only)
GET /api/v1/users/:id User profile details