RideEase is a ride-sharing application that provides convenient transportation services to users. It features user authentication with sign-up and login functionality, as well as a beautiful user dashboard to manage rides. Additionally, it offers an admin dashboard to view user data stored in a PostgreSQL database.
- User authentication: Sign up and login to access the application.
- User dashboard: Manage rides and view ride history.
- Admin dashboard: View user data and perform administrative tasks.
- PostgreSQL database: Data storage for user information and ride data.
Before running the RideEase application, you need to set up a PostgreSQL server. You can choose to run it locally, in a Docker container, or in a Kubernetes cluster.
Local setup: Install PostgreSQL on your local machine by following the official documentation: PostgreSQL Downloads.
If you prefer running RideEase in a Docker container, ensure that Docker is installed on your machine. You can pull the RideEase Docker image from Docker Hub using the following command:
docker pull ialexeze/rideease:user
docker pull ialexeze/rideease:admin
Launch the PostgreSQL container with the necessary environment variables and port mapping:
docker run -d --name postgresql -e POSTGRES_USER=postgres -e POSTGRES_PASSWORD=postgres -p 5432:5432 postgresl:alpine
Launch the User and Admin container with the necessary environment variables and port mapping:
docker run -d --name user -e POSTGRES_USER=postgres -e POSTGRES_PASSWORD=postgres -p 3000:3000 ialexeze/rideease:user
docker run -d --name admin -e POSTGRES_USER=postgres -e POSTGRES_PASSWORD=postgres -p 2000:2000 ialexeze/rideease:admin
To deploy RideEase in a Kubernetes cluster, ensure you have kubectl installed and configured to access your cluster. Apply the Kubernetes manifest files to create the necessary resources:
cd k8s
kubectl apply -f postgres.yaml
kubectl apply -f user.yaml
kubectl apply -f admin.yaml
Visit http://localhost:31000 in your browser. Sign up for a new account or log in if you already have one. After successful login, you will be redirected to the user dashboard.
Visit http://localhost:32000 in your browser.
This will display the admin dashboard to view user data and perform administrative tasks.
Contributions to RideEase are welcome! If you have any suggestions, improvements, or bug fixes, please open an issue or submit a pull request to the GitHub repository.
RideEase is released under the MIT License. Feel free to use, modify, and distribute the code as per the terms of the license.
Alex Eze Esther Oluebube
Acknowledgements RideEase utilizes various open-source libraries and frameworks. Special thanks to the contributors of the following projects:
Flask: Flask SQLAlchemy: SQLAlchemy Node.js: Node.js Express: Express.js PostgreSQL: PostgreSQL
For any inquiries or support, please contact the RideEase development team at rideease@example.com.