An open API service indexing awesome lists of open source software.

https://github.com/michaelbunch/notifications-minisys


https://github.com/michaelbunch/notifications-minisys

Last synced: 8 months ago
JSON representation

Awesome Lists containing this project

README

          

# Notifications Mini-system

This is a sample project for building a notification system with Go and Vuejs. It is intentionally
trite for the purpose of not over-engineering from the start with complexity added as needed.

## Running the API

The API requires MySQL for storing notifications and user data. It relies on environment variables
to pass database connection settings. You will need to have the following variables configured.

```
export DB_User=
export DB_Password=
export DB_Name=notifications-minisys
```

A sample database schema, with data, can be loaded from `sql/dump.sql`.

The Go code can be run with:

```
go run api.go
```

## Building the Frontend

All frontend assets are located in the `frontend` folder. They are built using Parcel and the generated artifacts are placed in `frontend/dist`.

```
npm i
npm run build
```