Couchers.org

Backend: . Landing site: .

Join us as we build the new online platform for couch-surfers

Non‑profit. Community‑focused. Well built.

Read more about us at Couchers.org.

All code in this repository is licensed under the MIT license.

How to contribute

If you found an issue with the app, or have a suggestion/feature you'd like to raise, please add it to the Issues (in the issues tab on GitHub). A developer will come and triage the issue and add it to the backlog.

If you are a developer, please read docs/contributing.md on our development model.

Overview of documentation

• Getting started with dev: app/readme.md outlines basic steps to get a dev environment set up, start here!
• Architectural overview: docs/architecture.md outlines the basic workings of the app, the different components, and the way they interact.
• Developer Contributor Guide: docs/contributing.md explains how we work with this codebase and helps you get up and running with development.
• CI/CD goodies: docs/cicd.md lists the different CI/CD functionality that we've got set up and how you can use this to simplify life
• Database & migrations: docs/database.md explains how to use the database and how we version the database with Alembic and update it when new tables or columns are added
• Docker: docs/docker.md has some tips on how to work with docker and be less miserable