nanomap/README.md

28 lines
1.3 KiB
Markdown
Raw Normal View History

2023-11-24 21:27:50 +08:00
<p align="center">
2023-11-24 21:25:50 +08:00
<img src="public/icon.jpeg" style="height: 100px; border-radius: 50%"/>
2023-11-24 21:27:50 +08:00
</p>
<h1 align="center">nanoMap</h1>
2023-11-24 16:32:07 +08:00
2023-11-24 21:25:50 +08:00
This project is a minimalized port for scheduling route on [OpenStreetMap](https://openstreetmap.org). This front-end application is built with [Create React App](https://create-react-app.dev/) and the basic functionality uses [React Leaflet](https://react-leaflet.js.org). For more information about the backend, please refer to [arielherself/nanomap-backend](https://github.com/arielherself/nanomap-backend).
2023-11-24 16:32:07 +08:00
2023-11-24 21:25:50 +08:00
# Deployment
2023-11-24 16:32:07 +08:00
2023-11-24 21:25:50 +08:00
## Vercel
2023-11-24 16:32:07 +08:00
2023-11-24 21:25:50 +08:00
An instance is deployed at https://nanomap.vercel.app<nothing>. You can also click the button below to deploy with your own account.
2023-11-24 16:32:07 +08:00
2023-11-24 21:25:50 +08:00
[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Farielherself%2Fnanomap-frontend&project-name=nanomap-frontend&repository-name=nanomap-frontend&demo-title=nanoMap&demo-description=A%20minimalized%20port%20for%20scheduling%20route%20on%20OpenStreetMap&demo-url=https%3A%2F%2Fnanomap.vercel.app)
2023-11-24 16:32:07 +08:00
2023-11-24 21:25:50 +08:00
## On your server
2023-11-24 16:32:07 +08:00
2023-11-24 21:25:50 +08:00
_Please install the latest version of [Node.js](https://nodejs.org) and [npmJS](https://www.npmjs.com) first._
2023-11-24 16:32:07 +08:00
2023-11-24 21:36:24 +08:00
Just four line of script:
2023-11-24 16:32:07 +08:00
2023-11-24 21:25:50 +08:00
```shell
git clone "https://github.com/arielherself/nanomap-frontend" nanomap &&
2023-11-24 21:36:24 +08:00
cd nanomap &&
2023-11-24 21:25:50 +08:00
npm install &&
npm start
2023-11-24 21:27:50 +08:00
```