PlaceCal is a large and very complicated app for collating organisation and event information from a large variety of sources. In the words of one developer: "I'm not sure where the interface between the app and the real world is here".
To get an idea of the project and what we're about, check out the handbook which is also in it's own respository, and especially the Glossary.
To run Placecal locally you will need:
- a mac or a linux machine
- gcc
- postgres relational database
- server
- either installed for your distribution or as a docker image (with the correct open port)
- client
- you will still need the local developer libraries for postgres
- these are distribution specific so you need to find out what they are called to install them
libpq-dev
(debian)postgresql-libs
(arch)dev-db/postgresql
(gentoo)
- server
- base ruby for your OS
- rbenv
- ruby-build
- rbenv-gemset (optional)
- ImageMagick
- node JS
- And yarn
With that said, here's what you need to get rolling.
git clone https://github.com/geeksforsocialchange/PlaceCal.git
bundle && yarn
bundle exec rails db:setup db:migrate seed:migrate
bundle exec rails import:all_events
bundle exec rails server
- Make sure you use
lvh.me:3000
instead oflocalhost
or you might have authentication problems. - Admin interface is
admin.lvh.me:3000
- Seeded root user is [email protected] / password
- Access code docs through your local filesystem, and update with
bundle exec rails yard
To set up your own server, take a look at INSTALL.md
.
We welcome new contributors but strongly recommend you have a chat with us in Geeks for Social Change's Discord server and say hi before you do. We will be happy to onboard you properly before you get stuck in.
If you'd like to support development, please consider sending us a one-off or regular donation on Ko-fi.