https://github.com/kenmwaura1/movr-app-1
This repo contains the source code for an example implementation of a single-region application for the fictional vehicle-sharing company MovR, as used by the CockroachDB for Python Developers course.
https://github.com/kenmwaura1/movr-app-1
Last synced: 5 days ago
JSON representation
This repo contains the source code for an example implementation of a single-region application for the fictional vehicle-sharing company MovR, as used by the CockroachDB for Python Developers course.
- Host: GitHub
- URL: https://github.com/kenmwaura1/movr-app-1
- Owner: KenMwaura1
- License: apache-2.0
- Created: 2021-11-09T21:24:30.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2021-11-09T21:24:38.000Z (almost 4 years ago)
- Last Synced: 2025-09-15T09:55:36.593Z (about 1 month ago)
- Language: Python
- Size: 529 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# MovR
This repo contains the source code for an example implementation of a single-region application for the fictional vehicle-sharing company MovR, as used by the CockroachDB for Python Developers course.
- [Overview](#overview) gives a high-level overview the MovR application stack.
## Overview
The application stack consists of the following components:
- A CockroachCloud instance
- Python class definitions that map to the table(s) in the database.
- A backend API that defines the application's connection to the database and the database transactions.
- A Flask server that handles requests from client web browsers.
- HTML templates that define web pages that the Flask server renders.
## Setup
### Database and Environment Setup
You'll need to connect to a [CockroachCloud](https://cockroachlabs.cloud/) cluster or locally running [CockroachDB cluster](https://www.cockroachlabs.com/docs/stable/start-a-local-cluster.html)
1. Configure environment variables
When running your server, it's easiest if your CockroachCloud connection
string is assigned to the DB_URI variable in the `.env` file. You can paste
it in with the editor of your choice.
2. Initialize the database
You can do this with
~~~ shell
$ cat dbinit.sql | cockroach sql --url
~~~
### Application setup
1. To run the application, use the following command in the shell:
~~~ shell
$ ./server.py run
~~~
2. To add environment variables, use the following command in the shell:
~~~ shell
$ cp .env.example .env
~~~
Modify the .env file to include your CockroachCloud/ localhost install connection string.
3. Navigate to the url provided (defaults to [http://localhost:36257](http://localhost:36257)) to use the application.
### Clean up
1. To shut down the application, `Ctrl+C` out of the Python process.
## Note: Testing
We are still building out the testing suite. Please use at your own risk.