Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alexgustafsson/threes
Easily create avatars from a username - Avatar as a Service
https://github.com/alexgustafsson/threes
api avatar avatar-generator avatar-service node saas typescript
Last synced: 2 months ago
JSON representation
Easily create avatars from a username - Avatar as a Service
- Host: GitHub
- URL: https://github.com/alexgustafsson/threes
- Owner: AlexGustafsson
- License: mit
- Created: 2019-04-19T13:25:23.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-03-04T03:36:40.000Z (almost 2 years ago)
- Last Synced: 2024-10-04T14:41:58.423Z (3 months ago)
- Topics: api, avatar, avatar-generator, avatar-service, node, saas, typescript
- Language: TypeScript
- Homepage:
- Size: 2.34 MB
- Stars: 7
- Watchers: 2
- Forks: 1
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Threes - Avatar as a Service
### Easily create avatars from a username - Avatar as a Service
***
### Quickstart
#### Using Docker
```
# Clone the repository
git clone https://github.com/AlexGustafsson/threes.git && cd threes
# Build the Docker image
docker build -t threes:latest .
# Run the image
docker run -p 3000:3000 threes
```
#### Running from source
```
# Clone the repository
git clone https://github.com/AlexGustafsson/threes.git && cd threes
# Install dependencies
npm install
# Build the project
npm run build
# Start the server
npm run start
```
### Documentation
#### Deploying
The project is easily run by using Docker:
```
docker build -t threes:latest .
docker run -p 3000:3000 threes
```
Or directly using `npx`:
```
npx threes
```
#### API
The exposed API is versioned and documented using OpenAPI in the following files:
* `api.v1.yml`
The API specifications can be used alongside software such as [Insomnia Designer or Insomnia Core](https://insomnia.rest/download/#mac) or the online [Swagger editor](https://editor.swagger.io).
##### Demo page
When run in development mode, a demo page is available to show all available styles. The demo page is available at the root of the server (`/`) and shown in the image at the top of this document.
### Contributing
Any contribution is welcome. If you're not able to code it yourself, perhaps someone else is - so post an issue if there's anything on your mind.
#### Development
Clone the repository:
```
git clone https://github.com/AlexGustafsson/threes.git && cd threes
```
Set up for development:
```
npm install
```
Run the project in development mode with automatic compilation and server reload:
```
npm run dev
```
Follow the conventions enforced:
```
npm run lint
npm run test
npm run coverage
```
### Disclaimer
_The project is intended for production use but is not yet heavily battle-tested. As such there may be implications when running threes in larger environments._
_All styles and palettes implemented are heavily inspired by the creative work of others. Whenever possible the sources are referenced within the code. If you believe you are the creative owner of an implemented style and would like for it to be removed for any reason, please open an issue._