{}[https://travis-ci.org/alexanmtz/truppie]
{}[http://www.truppie.com]
The trupe hippie chic exploring adventures platform: https://www.truppie.com
= Become a Truppist!
Welcome to the Truppie platform!
Here you will know how to contribute to this project.
== What is Truppie?
Truppie is a platform that connects tour guides with explorers, nature-lovers.
It is an Open Source project and is developed by coders like you!
Any developer from anywhere in the world can contribute with the platform and be assigned to do the issues.
Truppie is safe, we use SSL for all transactions.
https://user-images.githubusercontent.com/88840/37486823-f97abd90-288f-11e8-9300-40225d12fb6c.png
== How it works
- You choose the issue;
- If you have the requirements, we assign it to you;
- You send a pull request;
- We analyze your code;
- If it is good to merge, the code goes to production;
- You get paid for it.
If you are not a developer, you can also contribute to the project and be paid for it! How? By:
- Suggesting improvements in the platform;
- Requesting a bug fix.
We have a {Contribution Guideline}[https://github.com/alexanmtz/truppie/blob/master/CONTRIBUTING.md] to guide you to how contribute with content and code.
== Docker
==== Run the Rails server for development
docker-compose -f docker-compose-dev.yml up
==== Run the regular tests (unit and integration)
docker-compose -f docker-compose-test.yml up
==== Run the Cucumber tests
docker-compose -f docker-compose-test-e2e.yml up
== Advantages
As a developer, you can learn with a collaborative platform!
Be paid on demmand for new features, bug fixes and improvements on the project.
== Requirements
To work with us as a developer, you need to work well with TDD and BDD.
== For inform a bug
With you want to give feedback about bugs, you can open a issue describing:
- Which URL the bug happens
- What you would tried to do (action perfomed)
- Date and time
- Error message (if any)
=== Env variables to secure our working
- Postgres 9.4.5
- When you have the project installed, you can request the development env variables.
=== RELEASE NOTES
=== v2.0
- Better menu indication for guide admin
- Better support for turbolinks
- Update Rails
- Follow organizer
- Notify guide when user get interested in past tour
- Guidebooks created by a super admin
- Docker container in development (thanks @lucianojfj)
- Cucumber specs testing a basic user reservation flow
=== v2.0-beta
In this release we make the platform more stable and test with our first client.
So we make the platform more independent to tour guide, as well as giving the admin more control over the platform.
We create a first prototype of our guidebook, that will support tour guides that can be sent and sold for a user.
So we make a lot of improvements including:
- Invite guides in our e-mail marketing
- Visualize tours better on admin interface from a list
- Account and bank account issues to recognize a verified account
- Value suggested by user (thanks to @hugohernani)
- A lot of permission bugs and conflict between admin accounts
- Truppies on maps to explore (thanks to
- Improve in Truppie places, but will deserve a release just for that
- Release of http://dev.truppie.com using Github Pages that makes a open source documentation accessible
- Get our Truppie Devs members. We are almost 100!
==== v2.0-rc1
The Truppie platform open for guides registration.
A version with guides registration, tour linked to places that has it's own landing page.
So in this release is possible:
- The guide create a simple account
- The guide can create a account to link with bank account
- The guide after has his account verified he can receive the transfers
- A lot of bug fixes
- Multi-language support