Skip to content
/ rox Public

🌍 BeWelcome lets you share a place to stay, connect with travellers, meet up and find accommodation on your journey. It is and will always be a free, open source, non for profit, democratic community.

License

Notifications You must be signed in to change notification settings

BeWelcome/rox

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Repository files navigation

Rox the software running BeWelcome.org 🌏

GitHub CI

A community-driven hospitality exchange network

Image of BeWelcome Startpage

Why this is incredible 😍

  • 🛌Member profileswith focus on finding a place to stay
  • 🔎Search membersby map, location, username
  • 👬Comment systemto increase trust between each other
  • 📝Forum and groupsfor discussions
  • 🚣🚴Activities, galleriesto show who you are
  • 🔧Volunteer tools(safety, moderation, spam, rights member welcome tools and more)
  • 🌈On page translationfor 305 languages
  • 🙋💪 BeWelcome is people and volunteersLearn more

Join the team 👧👦👩👨

You like the idea? Development is only one way to contribute! Find out how toget active,including as designer, tester, translator, moderator, helping others and much more! 😍

Get your Rox development enviroment 💻

  1. 🎈Set up you local development enviromentand fork the repository on Github.
  2. 🔍 Pick agood starter issue
  3. ✨ Create apull requestand@mentionthe people from the issue to review
  4. 🌞 Fix the remaining things during review
  5. 🎉 Wait for it being merged!

You probably want to get started by checking out the code insrc/.

build/is deprecated and the code needs to be rewritten insrc/.

To make changes inJavascriptbear in mind that the Webpack needs to process each change before it reflects on the site. It is a good idea to runyarn encore dev --watchwhich will keep updating files as you keep saving them.

Documentation

Documentation isin the doc treeand can be compiled using mkdocs:

$ mkdocs build

The result can then be accessed viadoc/html/in your cloned repository.

Procedure

If you see an updatedcomposer.jsonorcomposer.lockmake sure to run

composer install --prefer-dist --no-progress --no-interaction --no-scripts

Also run

yarn install --frozen-lock

everytime you see a change in eitherpackage.jsonoryarn.lock.

If any.scssfile or a file inassets/changed amake buildis necessary.

Useful links

Coding standards

To ensure coding standards are followed runmakeeverytime before you commit. Fi xing coding standard issues can be achieved with

make phpcsfix

twice in a row.