https://github.com/shackspace/event-o-mat

Managing events for shackspace.de
https://github.com/shackspace/event-o-mat

Last synced: 4 days ago
JSON representation

Managing events for shackspace.de

• Host: GitHub
• URL: https://github.com/shackspace/event-o-mat
• Owner: shackspace
• License: other
• Created: 2018-03-22T17:24:35.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2022-12-07T23:50:24.000Z (almost 2 years ago)
• Last Synced: 2024-08-02T12:52:15.647Z (3 months ago)
• Language: Vue
• Size: 1.98 MB
• Stars: 5
• Watchers: 29
• Forks: 1
• Open Issues: 29
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

• awesome-starred - shackspace/event-o-mat - Managing events for shackspace.de (others)

README

        
event-o-mat

===========

.. image:: https://img.shields.io/travis/shackspace/event-o-mat.svg

   :target: https://travis-ci.org/shackspace/event-o-mat

   :alt: Continuous integration

.. image:: https://img.shields.io/codecov/c/github/shackspace/event-o-mat.svg

   :target: https://codecov.io/gh/shackspace/event-o-mat

   :alt: Coverage

event-o-mat is the shackspace event management software.

It consists of a `REST API`_ server backend written in Django_, and a single

page application frontend written in `vue.js`_.

Setup

-----

These are instructions for the development setup. If you want to run

event-o-mat in production, please refer to the ansible role instead.

To run the **server**, you'll need a Python 3.5+ virtualenv of some sort. Once

you've activated the virtualenv, execute in the ``server`` directory::

  python manage.py migrate

  python manage.py createsuperuser

  python manage.py runserver

At http://localhost:8000/admin, you can now log in and create the data you want

to work with. Go to http://localhost:8000/rooms, http://localhost:8000/events

etc to see the API for yourself.

If you make changes, add or edit the appropriate tests in ``tests/`` and run

``pytest tests`` in the ``server`` directory.

To run the **frontend**, go into the ``client`` directory, and execute::

  npm install

  npm start

.. _REST API: https://en.wikipedia.org/wiki/Representational_state_transfer

.. _Django: https://www.djangoproject.com/

.. _vue.js: https://vuejs.org/