Falso-server - NestJS Web Application

This is a web application built using NestJS framework for generating fake data using the great falso library.

⚠️ This is just a toy project I created to learn Nestjs

Features

✅ Generate fake data for various categories such as name, address, phone number, etc.

✅ Option to select the number of data items to generate.

✅ Option to create and save custom types with custom properties.

✅ Easy-to-use and intuitive Rest APIs.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

• Node.js
• NestJS
• MongoDB

Features

Installation on local machine

1. Clone the repository:

2. Install the dependencies:

yarn install

3. Create .env file with required env variables

cp .env.example .env

Running the Application

1. Start the development server:

yarn start:dev 

2. Visit API documentation at http://localhost:3000/swagger to use the API. Built With NestJS - The progressive Node.js framework Faker.js - A library for generating fake data

Installation using docker-composer

1. Clone the repository

2. Create .env file with required env variables

cp .env.docker .env

3. Start docker-compose

 docker-compose up -d --build

4. Visit API documentation at http://localhost:3000/openapi to use the API.

Examples of Usage:

List of available types (falso types):

curl --location --request GET 'http://localhost:3000/types' 

Response:

{
  "public": [
    {
      "name": "abbreviation",
      "properties": {}
    },
    {
      "name": "abn",
      "properties": {
        "onlyValid": "boolean"
      }
    },
    // ... other types
    {
      "name": "zip_code",
      "properties": {}
    }
  ]
}

Generate a user

curl --request GET 'http://localhost:3000/g/user'

Response:

{
    "id": "b5f994e4-67ae-4630-834b-c6a8a3bcd21c",
    "email": "mardkhayprins678@comcast.org",
    "firstName": "Mardkhay",
    "lastName": "Prins",
    "phone": "+1(664)289 3122",
    "img": "https://i.pravatar.cc/100",
    "username": "Mardkhay_Prins2",
    "address": {
        "street": "1489 Smitham Drive",
        "city": "West Janetborough",
        "zipCode": "37432",
        "county": "Worcestershire",
        "country": "Estonia"
    }
}

⚠️user is a defined type in falso library

Generate a list of users

curl --request GET 'http://localhost:3000/g/user?size=10'

Response:

[
  {
    "id": "c9d59684-d307-4c72-a442-405d436f79d9",
    "email": "nonhlanhla.brouwer@googlemail.com",
    "firstName": "Nonhlanhla",
    "lastName": "Brouwer",
    "phone": "+685 63 8765",
    "img": "https://i.pravatar.cc/100",
    "username": "Nonhlanhla_Brouwer",
    "address": {
      "street": "1441 Lockman Greens",
      "city": "Lawrence",
      "zipCode": "54985-6051",
      "county": "Herefordshire",
      "country": "Lao Peoples Democratic Republic"
    }
  },
  // ... other users
]

Generate a type with properties

curl --request GET 'http://localhost:3000/g/credit_card_number|brand:Visa?size=10'

Response:

[
    "4482 8689 7852 5099",
    "4425 0176 3413 7354",
    "4632 6942 4118 0221",
    "4836 3472 2327 2134",
    "4165 6143 0456 8782",
    "4849 3407 4708 8256",
    "4648 8197 7527 2723",
    "4813 5716 7557 9542",
    "4389 1781 6704 6187",
    "4266 2732 9494 1817"
]

Generate custom type with properties

curl -X POST http://localhost:3000/g
   -H "Content-Type: application/json"
   -d '{"firstname":{"type":"first_name","properties":{"withAccents":true}},"lastname":"last_name|withAccents:yes","Id":"number|min:11|max:12","phones":{"type":"phone_number","properties":{"countryCode":"MA"},"isArray":true,"size":2}}'

The POST /g endpoint accepts json body of a type with custom fields to generate: Example:

{
  // long format
    "firstname": {
        "type": "first_name",
        "properties": {
            "withAccents": true
        }
    },
  
    // show format for {"type": "last_name", "properties": {"withAccents": true}}
    "lastname":"last_name|withAccents:yes",
    "Id": "number|min:11|max:12",
  
    // this can also be written in short format
    // phone_number|isArray|size:2|countryCode:MA
    "phones": {
        "type": "phone_number",
        "properties": {
            "countryCode": "MA"
        },
        "isArray": true,
        "size": 2

    }
}

Create custom type

To create custom type you need to create an account first and login then use the access_token to create custom types

• use POST auth/registration to register

curl -X POST http://localhost:3000/auth/registration \
   -H "Content-Type: application/json" \
   -d '{"fullname": "Ya", "email": "yalhyane@gmail.com", "password": "1234", "confirmPassword": "1234"}'

• use POST auth/login to get an access_token

curl -X POST http://localhost:3000/auth/login \
   -H "Content-Type: application/json" \
   -d '{"email": "yalhyane@gmail.com", "password": "1234"}'

• use the POST /types endpoint to save the custom type as follows:

curl -X POST http://localhost:3000/types \
   -H "Content-Type: application/json" \
   -H "Authorization: Bearer Your-access-token" \
   -d '{"name": "person", "mapping": {"name": "full_name", "email": "email", "age": "number|min:10|max:100", "address": "full_address", "phones":  "phone_number|isArray|size:2|countryCode:MA"}}'

Then use can generate your custom type just like the builtin types

curl --request GET 'http://localhost:3000/g/person?size=10' \
   -H "Authorization: Bearer Your-access-token"

Check OpenAPI documentation at http://localhost:3000/openapi for more options.

Contributing

Feel free to raise issues or create pull requests to improve the code.

License

This project is licensed under the MIT License - see the LICENSE file for details.