GitHunt
AA

aaguilera/cride-platzi

REST API project used to teach Django on Platzi

Comparte Ride

Comparte Ride was a carpooling platform developed on 2016 as
an alternative for Mexico City inhabitants during an air pollution
alert

where the car usage was restricted and over 1.1 million cars
were banned from the streets.

During the environmental contingency a lot of people opted for
carpooling within their own communities but most of the information
about rides being shared was lost. As an immediate solution, some
friends and I decided to build a very simple website (using Django)
to gather and display information about this rides. The platform
quickly got some attention:

We believe Comparte Ride's popularity grew so fast because of the fact
that groups where private and that the only way to join a group
was by getting invited by someone that was already a member.

This project

I instructed an advanced course of Django
at Platzi where the main goal was to learn
how to professionally build a REST API. I choose this project because at the moment I was
planning the course a bunch of people reached out to Comparte Ride's inactive social
networks asking what happened to the project, and since it was also a very
simple project I thought it was a nice idea that developers from around
the globe learned to build an API around it.

Development

I stopped working for this project after the course finished. You can review
the code up to the course progress in the releases section, it is labeled as Deployment-bundle.. You can also check
the deployment guide here.

To start working on this project I highly recommend you to check
pydanny's Django Cookiecutter documentation on how to get this project up and running locally.
If you don't want to do so, just run:

docker-compose -f local.yml build
docker-compose -f local.yml up

Contributing

I'll be happily accepting pull requests from anyone, and if you are a
Platzi student I HIGHLY ENCOURAGE YOU TO CONTRIBUTE!

This that are missing right now:

  • Add tests and coverage implementations
  • Remove weak Token Authorization system
  • Implement more async and periodic tasks to improve the rating system
  • A UI!

Suggestions are welcome!

If this project get enough attention and participation, I'll be happy
to host it (the UI is required.)

Want to use this project as yours?

Please stick to the LICENSE, you can read a TL;DR
here.

Again, this is a project I liked a lot and I will love to see it live
again. Feel free to modify, distribute, use privately, etc (READ THE LICENSE) as
you please just include the Copyright and the LICENSE.

Contributors

Languages

Python90.2%Shell6.3%Dockerfile3.2%HTML0.3%

Contributors

MIT License
Created February 12, 2022
Updated January 15, 2022
aaguilera/cride-platzi | GitHunt