Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/alkem-io/server

Core server in the Alkemio platform, offering a GraphQL api for interacting with the logical domain model.
https://github.com/alkem-io/server

challenges docker graphql graphql-api graphql-server node projects society typeorm typescript

Last synced: about 1 month ago
JSON representation

Core server in the Alkemio platform, offering a GraphQL api for interacting with the logical domain model.

Host: GitHub
URL: https://github.com/alkem-io/server
Owner: alkem-io
License: eupl-1.2
Created: 2020-08-23T06:54:12.000Z (about 4 years ago)
Default Branch: develop
Last Pushed: 2024-04-13T08:59:07.000Z (7 months ago)
Last Synced: 2024-04-13T17:17:45.563Z (7 months ago)
Topics: challenges, docker, graphql, graphql-api, graphql-server, node, projects, society, typeorm, typescript
Language: TypeScript
Homepage: http://alkem.io
Size: 24.8 MB
Stars: 24
Watchers: 11
Forks: 4
Open Issues: 236
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        


  



Empowering society. The platform to succeed in working on challenges, together.


# Alkemio Server

Welcome to the Alkemio Server! This server is the heart of the Alkemio Platform, and manages the representation of the Space and all the entities stored wthin it.

[![Build Status](https://api.travis-ci.com/alkem-io/server.svg?branch=develop)](https://travis-ci.com/github/alkem-io/server)

[![Coverage Status](https://coveralls.io/repos/github/alkem-io/server/badge.svg?branch=develop)](https://coveralls.io/github/alkem-io/server?branch=develop)

![Docker Image CI](https://github.com/alkem-io/Server/workflows/Docker%20Image%20CI/badge.svg?branch=develop)

A high level overview of the Design of the Alkemio Server is shown below.







The server primarily interacts via a _*GraphQL api*_' that it exposes. This can be found at the following location:  (assuming default port).

This api is used by the [Alkemio Web Client](http://github.com/alkem-io/client-web), but also by any other clients / integrations that need to interact with the Alkemio server.

The key takeaway is that the Alkemio server is designed to be integrated, so that other tools or user interfaces can make use of the logical domain model maintained by the server.

## **Additional information**:

- [Design - An overview of architectural layers and technologies used](docs/Design.md)

- [Running - How to run the Server using containers (docker-compose and docker)](docs/Running.md)

- [Developing - How to setup the Server for developing](docs/Developing.md)

- [Data Management - How data representing the domain model used by Alkemio Platform is managed, including database migrations](docs/DataManagement.md)

- [Quality Assurance - Details of the test harness around the server and how to execute the test suites](docs/QA.md).

- [Pushing - How new docker images are published to Dockerhub](docs/Publishing.md)

- [Database defnitions - Guidelines for creating TypeORM entity definitions](docs/database-defnitions.md)

For other questions / comments please feel free to reach out via the channels listed in the [Alkemio Repo](http://github.com/alkem-io/alkemio) or via [Alkemio organization](https://alkemio.org).