compa

    1.0.0-alpha.4 • Public • Published

    Compa

    license AGPL v3 build status coverage status npm irc channel

    This is Compa */kompa/. It's a free (as freedom) worldwide social directory decentralized and federated with an ActivityPub API, this is a horizontal community project, anyone can run and participate and contribute, the focus of the project is work for a good user interface, a clean REST API and connecting the people for a better world.

    Compa use ActivtyPub as principal protocol and is compatible with Pump.io, Mastodon and other free/open source social networks

    What's Compa?

    You visited a bookstore, a library and you liked it so much that you would like others to know it, then you can create the site if it does not exist and share it with your friends or family or you are a traveler in search of new beautiful places to visit then Compa will be your travel guide based on sites that people have already rehared and valued.

    You can share any place like museums, natural park, libraries etc.

    Contributing

    You can open issues for bugs you've found or features you think are missing. You can also submit pull requests to this repository. Here are the guidelines for code contributions

    Fork -> Patch -> Push -> Pull Request

    For developer please see the guidelines for Code Contributions

    Join to IRC channel #compa on irc.freenode.net or see: Community

    Bugs

    If you find bugs, you can report them here:

    https://framagit.org/compa/compa/issues

    Installation

    Prerequisites

    You'll need four things to get started:

    • node.js 4.x or higher
    • npm 1.1.0 or higher
    • The graphicsmagick package with the gm command

    Install with npm

    The easiest way is to install the software globally using npm, like so:

    npm install -g compa
    

    That should set up all the files and dependencies for you.

    Local install

    If you want to set up the software in its own directory, you can clone the git repository, so:

    git clone https://framagit.org/compa/compa.git
    

    You can then install the dependencies using npm:

    cd compa
    npm install
    npm run build
    

    Getting Started

    For a basic setup please see the Getting Started Guide

    Wiki

    For more information please check out the Wiki and our ReadTheDocs documentation.

    FAQ

    • What mean Compa?
    • What is the idea behind this?
    • Etc.

    Please see FAQ for the answers for this and others questions.

    Roadmap

    This Roadmap is only for brainstorm, but you can make a idea of the priorities of this project.

    License

    GNU AGPLv3 Image

    Compa is Free Software: You can use, study share and improve it at your will. Specifically you can redistribute and/or modify it under the terms of the GNU AGPL 3.0 License as published by the Free Software Foundation.

    See the COPYING file for the full license text

    Install

    npm i compa

    DownloadsWeekly Downloads

    1

    Version

    1.0.0-alpha.4

    License

    AGPL-3.0

    Last publish

    Collaborators

    • vxcamiloxv
    • distopico