PlaceCal is an online calendar which lists events and activities by and for members of local communities, curated around interests and locality.
The codebase doesn't currently have enough seeds to create a dev environment suitable for developing from scratch. If you're interested in contributing to PlaceCal please get in touch at support@placecal.org
To get an idea of the project and what we're about, check out the handbook.
To run PlaceCal locally you will need to install the following dependencies:
Make sure all of the above dependencies are installed (and ask someone to add your public ssh key to the servers if you are staff).
Then make sure the docker daemon is running, and run
make setup_with_docker
Local site is now running at lvh.me:3000
Some other useful commands for developing can be found in the makefile.
If the make command fails and you can't work out why, here are some suggestions:
rails db:drop:all
nvm use
If you don't already have Postgresql installed and running, you can set it up with docker, just run make docker
. To tear down the docker setup, run make clean
.
bin/setup
Amongst other things, this will create an admin user for you:
root@placecal.org
password
bin/dev
lvh.me:3000
instead of localhost:3000
or you will have authentication problemsadmin.lvh.me:3000
bin/rails yard
To import all events, run the following command.
rails events:import_all_calendars
After this has run once, the following command can be run which attempts to skip calendars which have not been updated. This should be run regularly on a cron in production environments. If you are using dokku to deploy like we are, this is handled in the app.json
config file.
rails events:scan_for_calendars_needing_import
To import one calendar, run:
rails events:import_calendar[100]
# nb: zsh users will need to escape brackets
rails events:import_calendar\[100\]
PlaceCal tests are written in minitest. We use Rubocop to lint our Ruby code.
We use Prettier to format everything it's able to parse. We run this automatically as part of a pre-commit hook.
You can run the tests & rubocop with:
make test
Further documentation for PlaceCal is in the PlaceCal Handbook.
The developer Procfile will load a yard
language server, this is visible at http://localhost:8808
.
If you are working with the code and are completely lost you can also try the GFSC discord server where you can prod a human for answers.
We use view_component to make components, and you can create a new one by running rails g component <Name> <args>
Previously this system used mountain view, and some of the components are still generated using this.
More info here: https://viewcomponent.org/guide/generators.html
API examples and test environment are provided using Bruno.
Install it with your system package manager then point it at the collections
directory.
If you'd like to support development, please consider sending us a one-off or regular donation on Ko-fi. You can do this through the "support" button in GitHub at the top of this repo.