https://github.com/richplastow/gus
A generic user server, based on Nest.js, Express and Node, which manages user auth and accounts for multiple domains at once
https://github.com/richplastow/gus
Last synced: 4 months ago
JSON representation
A generic user server, based on Nest.js, Express and Node, which manages user auth and accounts for multiple domains at once
- Host: GitHub
- URL: https://github.com/richplastow/gus
- Owner: richplastow
- License: mit
- Created: 2024-06-03T19:22:36.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-06-03T23:57:37.000Z (about 1 year ago)
- Last Synced: 2025-01-06T01:10:36.430Z (5 months ago)
- Language: TypeScript
- Size: 104 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Gus
> A generic user server, based on Nest.js, Express and Node, which manages user auth and accounts for multiple domains at once.
- Created 20240603
- Rich Plastow
-
Primarily intended to be run as an AWS App Runner instance, connected to
a Google Firestore database.
- A single **Gus** instance can serve multiple unrelated apps
- Handles user authentication and credentials
- Can send emails to confirm sign-up, or to reset passwords
- Provides CRUD for user account/profile data, app-usage statistics, and more
- 'superadmin' access, for managing all apps in once place
## Installation
```bash
$ npm install
```
## Running the app
```bash
# development
$ npm run start
# watch mode
$ npm run start:dev
# production mode
$ npm run start:prod
```
## Test
```bash
# unit tests
$ npm run test
# e2e tests
$ npm run test:e2e
# test coverage
$ npm run test:cov
```
## Endpoints
### Anonymous, top-level endpoints
**`GET /`**
Responds with just two bytes, `ok`. All other endpoints use `application/json`
for their response `Content-Type`, but this endpoint uses `text/plain` instead.
Useful for AWS App Runner to 'ping' every 20 seconds, to show the app's running.