https://github.com/servicespack/users-api

👥 Users microservice ready and flexible for your system
https://github.com/servicespack/users-api

api api-blueprint crud microservice mongodb nodejs

Last synced: 15 days ago
JSON representation

👥 Users microservice ready and flexible for your system

• Host: GitHub
• URL: https://github.com/servicespack/users-api
• Owner: servicespack
• License: mit
• Created: 2017-11-27T02:27:03.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2024-11-25T19:50:54.000Z (2 months ago)
• Last Synced: 2024-11-25T20:36:29.142Z (2 months ago)
• Topics: api, api-blueprint, crud, microservice, mongodb, nodejs
• Language: JavaScript
• Homepage: https://ubox-api.herokuapp.com/
• Size: 5.44 MB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  



# Users API

[![Standard - JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](https://standardjs.com/)

![CI](https://github.com/gabrielrufino/users-api/workflows/ci/badge.svg)

Users microservice ready and flexible for your system

## Getting started

### Setup

```bash

git clone https://github.com/gabrielrufino/users-api/

cd users-api

cp .env.example .env

npm install

```

### Database

Fill correctly the environment variables in .env!

**example:**

```env

# users-api/.env

DB_CONNECTION=mongodb

DB_HOST=localhost

DB_PORT=27017

DB_USER=root

DB_PASS=root

DB_NAME=db_users_api

```

### Users API Ready!

Now, you can start the Users API!

```bash

npm run dev

```

Access http://localhost:3000! Users API is ready.

## LICENSE

The MIT License (MIT)