https://github.com/seancassiere/simple-logging-server

A simple server for storing logs.
https://github.com/seancassiere/simple-logging-server

Last synced: 21 days ago
JSON representation

A simple server for storing logs.

• Host: GitHub
• URL: https://github.com/seancassiere/simple-logging-server
• Owner: SeanCassiere
• License: mit
• Created: 2022-08-25T08:55:31.000Z (about 2 years ago)
• Default Branch: master
• Last Pushed: 2024-07-05T10:23:28.000Z (4 months ago)
• Last Synced: 2024-10-06T11:06:56.103Z (about 1 month ago)
• Language: TypeScript
• Homepage:
• Size: 2.5 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# Simple Logging Server

This is a dead simple log server that allows you to log messages to a persisted database.

## Development

1. Clone the repository.

2. Install dependencies `pnpm install`.

3. Create a `.env` file and add the necessary `secrets` into it. You can use the `.env.example` file as a reference.

4. Run the development server using `pnpm run dev`. If you haven't run an init on your database, run `pnpm run db:push`.

## Usage

OpenAPI 3 specification with Swagger explorer is available at `/docs`.

### Creating a service

To make any logs into the database, you'll need a valid service account which is active. These account should be regulated by yourself, and should not generated by the public.

You can use the `pnpm run db:explorer` to view the database, and create a service.

### Endpoints

Documentation for the available endpoints are OpenAPI 3 compliant. You can view the full documentation at `/docs`.

## Contributing

Contributions are always welcome!

See [CONTRIBUTION](CONTRIBUTION.md) for ways to get started.

Please adhere to this project's [CODE OF CONDUCT](CODE_OF_CONDUCT.md).

![Issues](https://img.shields.io/github/issues/SeanCassiere/simple-logging-server)

![Pull Requests](https://img.shields.io/github/issues-pr-closed/SeanCassiere/simple-logging-server)

## Authors

- [@SeanCassiere](https://github.com/SeanCassiere)