Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/youben11/open-class
OpenClass is a web app that promote information sharing through organized workshops.
https://github.com/youben11/open-class
django docker docker-compose dockerfile postgresql python redis webapp
Last synced: about 2 months ago
JSON representation
OpenClass is a web app that promote information sharing through organized workshops.
- Host: GitHub
- URL: https://github.com/youben11/open-class
- Owner: youben11
- License: gpl-3.0
- Created: 2018-03-01T06:03:09.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2018-11-23T19:10:53.000Z (about 6 years ago)
- Last Synced: 2024-05-20T03:14:17.853Z (7 months ago)
- Topics: django, docker, docker-compose, dockerfile, postgresql, python, redis, webapp
- Language: CSS
- Homepage:
- Size: 9.74 MB
- Stars: 8
- Watchers: 7
- Forks: 6
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-algeria - OpenClass - OpenClass is a web app that promotes information sharing through organized workshops. (Applications)
README
# What is OpenClass?
OpenClass is a web app that promote information sharing through organized workshops.
## Installation
OpenClass was developed to be mainly deployed using Docker, the following instructions will guide you to deploy OpenClass on a machine that has Docker already installed. Please visit this [link](https://docs.docker.com/install/) if you don't have Docker installed yet.
#### Get the source code
First run the following command to get the Project code:
```bash
$ git clone https://github.com/youben11/open-class
```
Then change your current directory to open-class:
```bash
$ cd open-class
```
###### NOTE :
If you don't have Git installed then download the code as a zip file and unzip it in open-class directory.
#### Start the server
For a simple usage run :
```bash
$ docker-compose up
```
It should take some time the first time your run this command (it depends on your connection), docker images will be pulled and built.
## How it works?
At the time that you start the server, your machine should have port 80 listening to receive HTTP requests.
The Docker Daemon should start 3 containers when you run `docker-compose` : web, db and db_redis.
- web is the container that is running the actual Django application, it is built using the Dockerfile provided. The server is binding his HTTP port to the HTTP port of this container.
- db is running a postgres image, the PostgreSQL database is used by the web app to store many information. The server is not binding any port to this container.
- db_redis is running a redis image, the redis database store information in a key/value fashion, which make it useful for storing the web app configuration. The server is not binding any port to this container.
All this containers are connected together in a local virtual LAN and can't be accessed from the outside unless a port is binded.
## Configuration
The first time that the server is started, the admin account is created with a username='admin' and a password='openclassadmin', you should change the password via the admin panel (example: http://localhost/admin/).
##### IMPORTANT !
Don't forget to change the admin's password.
## Want to contribute?
If you are willing to work with us on this project, please visit [this project board](https://github.com/youben11/open-class/projects/1) where you will find cards of functionalities that we aim to implement. take one of them and work on it, then submit a pull request. Thank you :D