Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thomasleveil/name-generator
generate name like Docker does for naming containers
https://github.com/thomasleveil/name-generator
Last synced: 18 days ago
JSON representation
generate name like Docker does for naming containers
- Host: GitHub
- URL: https://github.com/thomasleveil/name-generator
- Owner: thomasleveil
- License: unlicense
- Created: 2017-09-02T13:17:17.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-05-22T19:31:43.000Z (over 1 year ago)
- Last Synced: 2023-05-22T23:26:17.890Z (over 1 year ago)
- Language: JavaScript
- Homepage: http://name-generator.thomasleveil.fr/
- Size: 22.5 KB
- Stars: 2
- Watchers: 2
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Name generator
==============
This project provides a web service that generates random names to identify objects among humans.
It provides two collections :
- fr : names and french adjectives
- docker : same names and adjectives as the Docker project
Usage:
```bash
curl http://localhost:10010/fr
{"name":"Hannibal-outré"}
curl http://localhost:10010/docker
{"name":"naughty-minsky"}
```
| endpoint | description |
|--------------------------------------------------|----------------------------------|
| http://127.0.0.1:10010/fr/ | generates french names |
| http://127.0.0.1:10010/docker/ | generates names like Docker does |
| http://127.0.0.1:10010/swagger | Swagger API spec file |
Deploying with docker
---------------------
docker run -d -p 80:10010 tomdesinto/name-generator
Or, if you want to build the image yourself:
git clone https://github.com/thomasleveil/name-generator
cd name-generator
docker build -t name-generator .
docker run -d -p 80:10010 name-generator
The application is listening on port `80`
Deploying with docker-compose
-----------------------------
git clone https://github.com/thomasleveil/name-generator
cd name-generator
docker-compose up -d
The application is listening on port `80`
How to run
----------
git clone https://github.com/thomasleveil/name-generator
cd name-generator
npm install
### dev server
npm run dev
### prod server
npm run start
How to add data
---------------
See the [`data`](data) folder