š“āāļø Readers Beware: This is a school project š“āāļø
Welcome to the mobile app for our e-bike renting system.
Key Features:
Get a feel for the apps features, functionality, and user interface (we recommend visiting the site on your phone):
For a comprehensive view of all our related projects and to access the entire collection of repositories, please visit our root repository:
This root repository serves as the central hub for our projects, providing links and information to all associated repositories.
Here you will find instructions on how to set up and run all repositories on your local machine.
While we recommend using our root repository for a smoother ride, you may choose to set up this repository directly, especially if you're planning to adapt the code. So, if you're feeling adventurous and want to ditch the training wheels, follow the steps below.
This application utilizes MapLibre GL JS with tiles from MapTiler.
.env
file based on the .env.example
.PUBLIC_MAPTILER_API_KEY
with your own key from MapTiler.The app interfaces with a REST API connected to a backend server and database.
.env.example
file to .env
.PUBLIC_REST_API_URL
to the server's URL..env.example
file.To test the app locally, you need to create your own GitHub OAuth App for authentication (unless you remove the auth check or come up with another solution):
http://localhost:5173
.http://localhost:5173/callback
..env
file as PUBLIC_GITHUB_ID
and GITHUB_SECRET
.For a more detailed guide on setting up the GitHub OAuth App, check out this tutorial by yours truly.
Once you've created a project and installed the dependencies with npm install
(or pnpm install
or yarn
), start a development server:
npm run dev
# Optionally, to open the app in a new browser tab:
npm run dev -- --open
To create a production version of the app:
npm run build
You can preview the production build with npm run preview
.
To build a production version of the app and run it inside a container:
docker compose up --build
The app uses the node-adapter by default. You may need to install a different adapter for your target environment and change the app settings accordingly.