From 530d581898391eedfb191274646f8eeb8bf5b84e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Deimantas=20But=C4=97nas?= <40717783+itsmedmd@users.noreply.github.com> Date: Sun, 17 Apr 2022 12:53:18 +0300 Subject: [PATCH] Update README.md --- README.md | 35 ++++++----------------------------- 1 file changed, 6 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index b12f3e3..89c9cee 100644 --- a/README.md +++ b/README.md @@ -1,34 +1,11 @@ -This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app). +# Satellite Tracker -## Getting Started +A website where you can track real-time positions of almost 20,000 satellites orbiting the Earth in a 3D geospatial viewer. -First, run the development server: + This project uses publicly available satellite TLE (Two-Line Element) data sets that are easily accessible and provided by [CelesTrak](https://celestrak.com/NORAD/elements/). -```bash -npm run dev -# or -yarn dev -``` +To make any practical use of the TLE data, the project uses Shashwat Kandadai's JavaScript library called [satellite.js](https://github.com/shashwatak/satellite-js) for satellite position propagation via TLE data sets that contain orbital information about each object. -Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. +All objects are then rendered in a 3D geospatial viewer provided by [Cesium](https://cesium.com). By the nature of the data contained within TLE sets, it is possible to determine the position of each object at any given moment in time, be it the present, the future or the past. The project makes use of this feature with the "time flow multiplier" slider. -You can start editing the page by modifying `pages/index.js`. The page auto-updates as you edit the file. - -[API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://localhost:3000/api/hello](http://localhost:3000/api/hello). This endpoint can be edited in `pages/api/hello.js`. - -The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead of React pages. - -## Learn More - -To learn more about Next.js, take a look at the following resources: - -- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API. -- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial. - -You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome! - -## Deploy on Vercel - -The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js. - -Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details. +You can find live version [here](https://satellites-itsmedmd.vercel.app).