Skip to content

Commit

Permalink
Merge 7371003 into 785ec1e
Browse files Browse the repository at this point in the history
  • Loading branch information
RubenVerborgh committed Sep 3, 2020
2 parents 785ec1e + 7371003 commit 52b0de9
Showing 1 changed file with 29 additions and 5 deletions.
34 changes: 29 additions & 5 deletions README.md
@@ -1,10 +1,34 @@
# community-server
# Community Solid Server
[![Build Status](https://travis-ci.com/solid/community-server.svg?branch=master)](https://travis-ci.com/solid/community-server)
[![Coverage Status](https://coveralls.io/repos/github/solid/community-server/badge.svg)](https://coveralls.io/github/solid/community-server)
[![npm version](https://img.shields.io/npm/v/@solid/community-server)](https://www.npmjs.com/package/@solid/community-server)

Implementation of the Solid server.
**An open and modular implementation of the [Solid specifications](https://solid.github.io/specification/)**

The architecture is based on the description [here](https://github.com/RubenVerborgh/solid-server-architecture).
We follow the Inrupt [coding standards](https://github.com/inrupt/public-documentation/blob/master/coding-conventions/javascript-coding-standards.md) where feasible.
An initial dummy implementation with some examples can be found [here](https://github.com/RubenVerborgh/solid-server-ts).
- Community Solid Server is open software
to provide people with their own [Solid](https://solidproject.org/) Pod.

- It will give developers an environment
to create and test new Solid applications.

- Its modular architecture will allows us
to try out new ideas on the server side
and thereby shape the future of Solid.

## Current status
This software is in **alpha status**,
which means it is **too early for use with Solid apps**.

However, you can already boot up the server,
play around with it,
and check how it is made.
<br>
The [architectural diagram](https://github.com/RubenVerborgh/solid-server-architecture)
can help you find your way.

If you are interested in helping out with the development of this server,
be sure to have a look at the [developer notes](https://github.com/solid/community-server/wiki/Notes-for-developers)
and [good first issues](https://github.com/solid/community-server/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22).

## Running locally

Expand Down

0 comments on commit 52b0de9

Please sign in to comment.