diff --git a/README.md b/README.md index 2568f91..c1044ae 100644 --- a/README.md +++ b/README.md @@ -1,43 +1,63 @@ -# GPS Tracker +# GPSTracker -A web interface to render GPS data points stored in a PostgreSQL database on a map. +##### Track your GPS data, from any data source -## Installation +GPSTracker is a simple Webapp that consists of: -1. Clone the repository: - ```bash - git clone https://github.com/yourusername/gps-tracker.git - cd gps-tracker - ``` +- A backend that: + - Can read GPS data from any compatible data source (supported: `postgres`, `mysql`, `mariadb`, `mongodb`, `sqlite`, + `snowflake`), with arbitrary complex filtering, and expose them over a simple Web API. + - [[*TODO*]] Can ingest GPS data points from HTTP, MQTT, Websocket or Kafka. +- A frontend to display GPS data points and provides advanced filtering. -2. Install dependencies: - ```bash - npm install - ``` +## Building the application -3. Create a `.env` file with the following content: - ```env - DATABASE_URL=postgres://username:password@localhost:5432/gpstracker - PORT=3000 - ``` +```sh +# Backend +npm install +npm run build -4. Create the `gps_data` table in your PostgreSQL database: - ```sql - CREATE TABLE gps_data ( - id SERIAL PRIMARY KEY, - latitude FLOAT NOT NULL, - longitude FLOAT NOT NULL, - created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP - ); - ``` +# Frontend +cd frontend +npm install +npm run build +``` -5. Start the server: - ```bash - npm start - ``` +## Configuration -6. Open your browser and navigate to `http://localhost:3000`. +See [`.env.example`](./.env.example) for a reference. Copy it to `.env` and modify it accordingly. -## Usage +## Running the application -Add your GPS data points to the PostgreSQL ▋ +### Local installation + +```sh +npm run start +``` + +### Docker + +[[*TODO*]] + +## Project Setup + +### Compile and Hot-Reload for Development + +#### Backend + +```sh +npm run dev +``` + +#### Frontend + +```sh +cd frontend +npm run dev +``` + +### Lint with [ESLint](https://eslint.org/) + +```sh +npm run lint +``` diff --git a/frontend/README.md b/frontend/README.md index 51661b1..975d5a5 100644 --- a/frontend/README.md +++ b/frontend/README.md @@ -1,56 +1,30 @@ -# GPSTracker +# GPSTracker [frontend] -##### Track your GPS data, from any data source +This is the root folder for the GPSTracker frontend. -GPSTracker is a simple Webapp that consists of: +See [main `README`](../README.md) for more information. -- A backend that: - - Can read GPS data from any compatible data source (supported: `postgres`, `mysql`, `mariadb`, `mongodb`, `sqlite`, - `snowflake`), with arbitrary complex filtering, and expose them over a simple Web API. - - [[*TODO*]] Can ingest GPS data points from HTTP, MQTT, Websocket or Kafka. -- A frontend to display GPS data points and provides advanced filtering. - -## Building the application +## Building the frontend ```sh -# Backend -npm install -npm run build - -# Frontend -cd frontend npm install npm run build ``` ## Configuration -See `.env.example` for a reference. Copy it to `.env` and modify it accordingly. +Imported from the root level - see [`.env.example`](../.env.example). -## Running the application - -### Local installation +## Running the frontend ```sh npm run start ``` -### Docker - -[[*TODO*]] - ## Project Setup ### Compile and Hot-Reload for Development -#### Backend - -```sh -npm run dev -``` - -#### Frontend - ```sh cd frontend npm run dev