https://github.com/RandomAPI/Randomuser.me-Node

Source code that powers randomuser.me
https://github.com/RandomAPI/Randomuser.me-Node

Last synced: 6 days ago
JSON representation

Source code that powers randomuser.me

• Host: GitHub
• URL: https://github.com/RandomAPI/Randomuser.me-Node
• Owner: RandomAPI
• License: mit
• Created: 2016-02-11T20:43:41.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2024-03-08T20:14:24.000Z (8 months ago)
• Last Synced: 2024-11-05T03:42:43.046Z (9 days ago)
• Language: JavaScript
• Homepage: https://randomuser.me
• Size: 2.77 MB
• Stars: 1,357
• Watchers: 34
• Forks: 274
• Open Issues: 33
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Randomuser.me-Node

### About

This is the source code that powers the randomuser.me User Generator.

Our goal is to have a very diverse database that consists of data unique to different nationalities.

While some places might have an SSN or their phone number might be formatted a certain way, other places usually follow a completely different set of rules.

Help us make the Random User Generator better by contributing to our database and teaching us the proper way of formatting data for different nationalities.

### Guidelines

If you would like to help contribute data specific to a region, please keep these few rules in mind:

1. Only add new nat data to the `api/.nextRelease` directory...

2. Please keep all of the data organized.

    - Keep US data in the US directory, AU in the AU directory, etc.

3. No duplicates. Make sure that the data you are adding isn't already on the list.

    - An easy way to remove duplicates from your file and sort: 

```sh

sort -u  -o 

```

4\. Please don't submit requests that say "make this nationality". We will accept helpful contributions, but not orders :)

### Requirements

Node v9.0.0+

MongoDB

### How to use

1. Run `npm install`

2. Run `npm run build` to build views and minify js/css

3. Run `npm test` and verify all tests pass

4. Start the server with `npm start`

### What if I want to add a new nationality?

Go ahead! We will gladly accept new regions if they follow the guidelines above.

Just place your files in a new directory in the `api/.nextRelease/data` folder with the appropriate 2 letter ISO Country Code (http://countrycode.org). Follow the format of the US folder for reference.

### How to contact us

If you have any questions, feel free to ask us on our Twitter page [@randomapi](https://twitter.com/randomapi).