ocelot.social

ocelot.social is a nonprofit social, action and knowledge network that connects information to action and promotes positive local and global change in all areas of life.

Social: Interact with other people not just by commenting their posts, but by providing Pro & Contra arguments, give a Versus or ask them by integrated Chat or Let's Talk
Knowledge: Read articles about interesting topics and find related posts in the More Info tab or by Filtering based on Categories and Tagging or by using the Fulltext Search.
Action: Don't just read about how to make the world a better place, but come into Action by following provided suggestions on the Action tab provided by other people or Organisations.

Live demo

Try out our deployed development environment.

Logins:

email	password	role
`user@example.org`	1234	user
`moderator@example.org`	1234	moderator
`admin@example.org`	1234	admin

Directory Layout

There are four important directories:

Backend runs on the server and is a middleware between database and frontend
Frontend is a server-side-rendered and client-side-rendered web frontend
Cypress contains end-to-end tests and executable feature specifications

In order to setup the application and start to develop features you have to setup frontend and backend.

There are two approaches:

Local installation, which means you have to take care of dependencies yourself
Or Install everything through Docker which takes care of dependencies for you

Installation

Clone the Repository

Clone the repository, this will create a new folder called Ocelot-Social:

Using HTTPS:

$ git clone https://github.com/Ocelot-Social-Community/Ocelot-Social.git

Using SSH:

$ git clone git@github.com:Ocelot-Social-Community/Ocelot-Social.git

Change into the new folder.

$ cd Ocelot-Social

Docker Installation

Docker is a software development container tool that combines software and its dependencies into one standardized unit that contains everything needed to run it. This helps us to avoid problems with dependencies and makes installation easier.

General Installation of Docker

There are several ways to install Docker CE on your computer or server.

Check the correct Docker installation by checking the version before proceeding. E.g. we have the following versions:

$ docker --version
Docker version 18.09.2
$ docker-compose --version
docker-compose version 1.23.2

Start Ocelot-Social via Docker-Compose

For Development:

$ docker-compose up

For Production:

$ docker-compose -f docker-compose.yml up

This will start all required Docker containers

Deployment

Deployment methods can be found in the Ocelot-Social-Deploy-Rebranding repository.

The only deployment method in this repository is docker-compose for development purposes as described above.

Developer Chat

Join our friendly open-source community on Discord 😻 Just introduce yourself at #introduce-yourself and mention @@Mentor to get you onboard Check out the contribution guideline, too!

We give write permissions to every developer who asks for it. Just text us on Discord.

Technology Stack

Attributions

Locale Icons made by Freepik from www.flaticon.com is licensed by CC 3.0 BY.

Browser compatibility testing with BrowserStack.

License

See the LICENSE file for license rights and limitations (MIT).

vgenev/Ocelot-Social