Skip to content

Latest commit

 

History

History
52 lines (40 loc) · 2.31 KB

README.md

File metadata and controls

52 lines (40 loc) · 2.31 KB

OpenWebServices

GitHub Actions Workflow Status GitHub Actions Workflow Status GitHub License GitHub issues

OpenWebServices is the UF Open Source Club's Microservices project. It currently implements a custom OAuth2 server, SMTP relay, and account management dashboard. It hopes to establish a common set of developer and project infrastructure services for use across the Open Source Club's projects. All microservices integrate with Kubernetes.

Install

This project uses the Go compiler and NodeJS.

git clone https://github.com/ufosc/OpenWebServices.git
cd OpenWebservices/dashboard
npm i

Quick Start

The project consists of three components: the authentication (Oauth2) server, the dashboard frontend, and the websmtp relay server. To get started, begin by launching the auth server:

cd oauth2
go run ./...

In a separate terminal, launch the NextJS dashboard:

cd dashboard
npm run dev

This will get you a minimal working example - with no database or SMTP integration. For additional configuration options, see the Documentation section.

Documentation

Each microservice is documented in its own individual README.md, within its respective directory. Documentation is currently sparse; in the future, a dedicated documentation page will be hosted on docs.ufosc.org. Currently available documentation is listed below:

Maintainers

Maintained by the UF Open Source Club, can be contacted via Discord

Current Maintainers:

  • Michail Zeipekki @zeim839
  • Daniel Wildsmith @danielwildsmith

License

AGPL-3.0

Copyright (C) 2024 Open Source Club