/user-management

TypeScript + KnexJS + Postgres | Project to manage users

Primary LanguageTypeScriptMIT LicenseMIT

User Management

Manage Users and Loyalty them.

📎 Sumário

Getting started

Used Technologies

📌 Most Used Technologies

Requisites

  • You need NodeJS.

  • I used Yarn, you can use npm if you prefer to.

  • I'd recommend you use Postgres.

  • Configure knexfile.ts

     connection: {
    host: 'localhost',
    port: 5433,
    user: 'postgres',
    password: 'docker',
    database: 'postgres',
},

Installation

# Clone repository
git clone https://github.com/cKauan/user-management.git

# Install all packages

# Yarn
yarn install
# Npm
npm install


# Run migrations

# Yarn
yarn knex migrate:latest
# Npm
npx knex migrate:latest

# Run seeds

# Yarn
yarn knex seed:run

# Npm
npx knex seed:run

Run Server

# Development server

# Yarn
yarn start:dev
# Npm
npm run start:dev

# Production Environment

# Yarn
yarn build
# Npm
npm run build

# Start project in production

# Yarn
yarn start
# Npm
npm run start

Styles

Eslint

  # Find all nonstandard occurrences

  # Yarn
  yarn lint
  # Npm
  npm run lint
  
  # Fix all nonstandard occurrences
  
  # Yarn
  yarn lint:fix
  # Npm
  npm run lint:fix

Prettier

  # Find all nonstandard occurrences

  # Yarn
  yarn style:check
  # Npm
  npm run style:check
  
  # Fix all nonstandard occurrences
  
  # Yarn
  yarn style:fix
  # Npm
  npm run style:fix

Environment Variables

  • Create a .env file

    JWT_SECRET=
ADMIN_EMAIL=
    Variable Description
    JWT_SECRET A identifier for your jwt token
    ADMIN_EMAIL The email you need to create other admin accounts

Documentation

Dashboard Routes

Method Path Description Body
GET /users get the users list ordered by id No Body
POST /users create a new user Json
PUT /user<id> update an user by id Json
DELETE /user<id> delete an user by id No Body

  • GET

    • Header Authorization Authorization: Bearer <token>

      token must be valid. See: How to get a token

    • Query Params

      Param Description Required Example
      page Defines the page false /users?page=2

    • Response Example

      200 - Success

      {
  "data": 
  [
    {
      "name": "Carlos Kauãn Moreira de Sousa",
      "phone": "5585992476020",
      "bought": 500,
      "notes": "Estudando back-end",
      "created_at": "2020-11-16T19:22:56.065Z",
      "id": 3
    },
    {
      "name": "Carlos Kauãn",
      "phone": "5585992476020",
      "bought": 500,
      "notes": "Estudando back-end",
      "created_at": "2020-11-16T19:22:56.065Z",
      "id": 2
    },

  ],
  "total": 1
}

      See: Error Docs

  • POST

    Field Description Type
    name user name string
    phone user phone string
    bought how much user bought number
    notes notes about user string

    • Header Authorization

      Authorization: Bearer <token>

      token must be valid. See: How to get a token

    • Request Example

        {
    "name": "Carlos",
    "phone": "5585992476020",
    "bought": 650,
    "notes": "Estudando"
  }

    • Response Example

      201 - Success

       {
    "id": 34,
    "name": "Carlos",
    "phone": "5585992476020",
    "bought": 650,
    "notes": "Estudando",
    "created_at": "2020-11-16T18:23:54.381Z"
 }

      See: Error Docs

  • PUT

    • Header Authorization Authorization: Bearer <token>

      token must be valid. See: How to get a token

    • Request Example

        {
    "name": "José Silva",
    "bought": 1000
  }

    • Response Example

      201 - Success: Returns the updated user.

       {
   "id": 36,
   "name": "José Silva",
   "phone": "5585992476020",
   "bought": 1000,
   "notes": "Estudando back-end",
   "created_at": "2020-11-16T19:22:56.065Z"
 }

      See: Error Docs

  • DELETE

    • Header Authorization Authorization: Bearer <token>

      token must be valid. See: How to get a token

    • Response Example 200 - Success

       {
    "message": "Deleted"
 }

      See: Error Docs

Admin Routes

Method Path Description Body
POST /sign register a new admin Json
GET /login login into admin account No Body

  • GET

    • Header Authorization

      Authorization: Basic <basic64credentials>

      • Encoded: Authorization: Basic Y2FybG9za2F1YW5AZ21haWwuY29tOmNhcmxvczEyMw==

      • Decoded: Authorization: Basic carloskauan@gmail.com:carlos123

    • Response Example

      201 - Success

       {
    "id": "4802f5a1-7e53-4c4c-8f60-e1c7ec4c161b",
    "name": "Carlos Kauãn",
    "email": "carloskauan@gmail.com",
    "token": "<token>"
  }

      See: Error Docs

  • POST

    Field Description type
    name admin name string
    email admin email string
    password admin password string

    • Header Authorization

      Authorization: Bearer <token>

      token must be a valid superuser. See: How to get a admin token

    • Request Example

       {
   "name": "Carlos Kauãn",
   "email": "carloskauan@gmail.com",
   "password": "carlos123"
 }

    • Response Example

      201 - Success

        {
    "id": "0554ec30-db86-4109-ae7d-0a3169e6a831",
    "name": "Carlos Kauãn",
    "email": "carloskauan@gmail.com",
    "token": "<token>"
  }

      See: Error Docs

Error Docs

Common errors

Code Description Action
400 Validation Fails Review json body
401 Authentication Fails Review your credentials
500 Internal Server Error Review server connection and database

FAQ

How do I get a token?

  • There're 2 ways to get a token

    • Creating an admin account
    • Logging into an admin account

    See: Admin Routes

How get a valid superuser token?

  • When You run the seeds, a default superuser is created

  • You need login into that account and get it token

  • The default account is

    email: carloskauanmoreiradesousa@gmail.com
password: carlos123

  • To change it by default, put ADMIN_EMAIL into .env file and change 002_admin.ts file.

  • The admin seed password must be encrypted with bcrypt 10 rounds

Contributing

🎯 Do you wanna contribute and don't know why?

  1. Fork Project
  2. Create a branch for your feature (git checkout -b feature/AmazingFeature)
  3. Commit (git commit -m 'Add some AmazingFeature')
  4. Push to your branch (git push origin feature/AmazingFeature)
  5. Open a pull request

License

MIT

Contact

👦 Carlos Kauãn - https://twitter.com/carlaodamassaa - carloskauanmoreiradesousa@gmail.com

Feito com 💚 por Carlos Kauãn