Skip to content

Commit

Permalink
Initial Commit
Browse files Browse the repository at this point in the history
Related Bot: https://t.me/TheRide_bot
Related Bot Description: Use this bot to request fictional Rides.

Mini App: https://t.me/TheRide_bot/TRide
Mini App Description: a Mini App that provides a demo flow for request fictional rides (motorcycle, car, helicopter).
                      User is presented with a map where they can select their location (source location) and destination location, then choose vehicle type and finally place a sample request
  • Loading branch information
ArashYounesi committed Oct 10, 2023
1 parent 0c67c45 commit 6beec99
Show file tree
Hide file tree
Showing 61 changed files with 7,978 additions and 2 deletions.
14 changes: 14 additions & 0 deletions .eslintrc.cjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
/* eslint-env node */
require('@rushstack/eslint-patch/modern-module-resolution')

module.exports = {
root: true,
'extends': [
'plugin:vue/vue3-essential',
'eslint:recommended',
'@vue/eslint-config-prettier/skip-formatting'
],
parserOptions: {
ecmaVersion: 'latest'
}
}
28 changes: 28 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
pnpm-debug.log*
lerna-debug.log*

node_modules
.DS_Store
dist
dist-ssr
coverage
*.local

/cypress/videos/
/cypress/screenshots/

# Editor directories and files
.vscode/*
!.vscode/extensions.json
.idea
*.suo
*.ntvs*
*.njsproj
*.sln
*.sw?
8 changes: 8 additions & 0 deletions .prettierrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"$schema": "https://json.schemastore.org/prettierrc",
"semi": false,
"tabWidth": 2,
"singleQuote": true,
"printWidth": 100,
"trailingComma": "none"
}
8 changes: 8 additions & 0 deletions .vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"recommendations": [
"Vue.volar",
"Vue.vscode-typescript-vue-plugin",
"dbaeumer.vscode-eslint",
"esbenp.prettier-vscode"
]
}
57 changes: 55 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,55 @@
# TRide
a Mini App that provides a demo flow for request fictional rides (motorcycle, car, helicopter). User is presented with a map where they can select their location (source location) and destination location, then choose vehicle type and finally place a sample request
# T Ride

a Mini App that provides a demo flow for request fictional rides (motorcycle, car, helicopter). User is presented with a map where they can select their
location (source location) and destination location, then choose vehicle type and finally place a sample request

<u>Note that this project hasn't server side part and generate mock data in client side</u>

### Info

- Related Telegram Bot: [@TheRide_bot](https://t.me/TheRide_bot)
- Mini App URL: [TheRide](https://t.me/TheRide_bot/TRide)

### Features

- Wrriten in [Vue Js](https://vuejs.org/)
- Beautiful and eye-catching appearance
- Componetn based
- Provides map for select source and destination location using power of [Mapbox](https://www.mapbox.com/)
- Provides a demo flow for request fictional rides includes Bike, Car and Helicopter

### Requirements

- Familiarity with the command line
- [Node.js](https://nodejs.org/) v16 or newer.

### Installation

- Install [Node.js](https://nodejs.org/) v16 or newer
- Clone the repo - `git clone https://github.com/ArashYounesi/TRide`
- Go to project directory - `cd project_folder`
- Install project dependencies — `npm install`.
- Launch the app — `npm run dev`, it will become available at [http://localhost:5173](http://localhost:5173/).

### Deployment - Lunch on Telegram

#### requirements

- Telegram bot
- Server to deploy project on it
- Domian connected to server

In order to use this project as a [Telegram Mini App](https://core.telegram.org/bots/webapps) some requirements needs:

- Build project - `npm run build` (dist directory will created)
- Upload files in `dist` folder to server
- Create a new telegram bot using [BotFather](https://t.me/botfather) (`/newbot`)
- Create a new web app based on created bot using [BotFather](https://t.me/botfather) (`/newapp`)
- Lunch using link BotFather gives you

You can also edit your Mini App url, name, ... using [BotFather](https://t.me/botfather) (`/myapps`)
For detailed information about Telegram Bot and Mini App please visit [Telegram Mini App](https://core.telegram.org/bots/webapps)

### License

[MIT](https://choosealicense.com/licenses/mit/)
14 changes: 14 additions & 0 deletions index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<link rel="icon" href="/favicon.ico">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>T Ride</title>
<script src="https://telegram.org/js/telegram-web-app.js"></script>
</head>
<body>
<div id="app"></div>
<script type="module" src="/src/main.js"></script>
</body>
</html>

0 comments on commit 6beec99

Please sign in to comment.