zrcadlo https://github.com/atscan/atscan
Update READMEs
This commit is contained in:
rodič
1d7f5562bf
revize
9f08aca3f8
19
README.md
19
README.md
|
@ -4,22 +4,31 @@
|
|||
|
||||
This is a monorepo containing the backend and frontend of ATScan.
|
||||
|
||||
The current version is hosted at [atscan.net](https://atscan.net).
|
||||
The current version is hosted at [atscan.net](https://atscan.net). You can follow us on Bluesky as [@atscan.net](https://bsky.app/profile/did:plc:ft3tl5dxjn4psdk6asenqn3r).
|
||||
|
||||
You can follow us on Bluesky as [@atscan.net](https://bsky.app/profile/did:plc:ft3tl5dxjn4psdk6asenqn3r).
|
||||
|
||||
## Technologies used
|
||||
## Technology stack
|
||||
|
||||
### Backend
|
||||
- [Deno](https://deno.land/) JavaScript runtime
|
||||
- [MongoDB](https://www.mongodb.com/) database
|
||||
- [oak](https://github.com/oakserver/oak) HTTP middleware framework
|
||||
- [NATS](https://nats.io/) messaging for sockets
|
||||
- [InfluxDB](https://github.com/influxdata/influxdb) time series platform
|
||||
- [Ajv](https://ajv.js.org/) JSON Schema validator
|
||||
|
||||
### Frontend
|
||||
- [Node.js](https://nodejs.org/en) JavaScript runtime
|
||||
- [SvelteKit](https://kit.svelte.dev/) JavaScript UI framework
|
||||
- [Tailwind CSS](https://tailwindcss.com/) CSS framework
|
||||
- [Tailwind](https://tailwindcss.com/) CSS framework
|
||||
- [Skeleton](https://www.skeleton.dev/) UI toolkit
|
||||
- [Apache ECharts](https://echarts.apache.org/en/index.html) visualization library
|
||||
- [date-fns](https://date-fns.org/) date library
|
||||
- [Numbro](https://numbrojs.com/) number library
|
||||
- [Minidenticons](https://github.com/laurentpayot/minidenticons) identicon generator
|
||||
|
||||
### CLI
|
||||
- [Deno](https://deno.land/) JavaScript runtime
|
||||
- [Cliffy](https://cliffy.io/) commandline framework
|
||||
|
||||
## Authors
|
||||
- Tree (GitHub: [@burningtree](https://github.com/burningtree), Bluesky: [@tree.fail](https://bsky.app/profile/did:plc:524tuhdhh3m7li5gycdn6boe))
|
||||
|
|
|
@ -1,24 +1,8 @@
|
|||
# create-svelte
|
||||
|
||||
Everything you need to build a Svelte project, powered by
|
||||
[`create-svelte`](https://github.com/sveltejs/kit/tree/master/packages/create-svelte).
|
||||
|
||||
## Creating a project
|
||||
|
||||
If you're seeing this, you've probably already done this step. Congrats!
|
||||
|
||||
```bash
|
||||
# create a new project in the current directory
|
||||
npm create svelte@latest
|
||||
|
||||
# create a new project in my-app
|
||||
npm create svelte@latest my-app
|
||||
```
|
||||
# atscan-frontend
|
||||
|
||||
## Developing
|
||||
|
||||
Once you've created a project and installed dependencies with `npm install` (or
|
||||
`pnpm install` or `yarn`), start a development server:
|
||||
Development server:
|
||||
|
||||
```bash
|
||||
npm run dev
|
||||
|
@ -36,6 +20,3 @@ npm run build
|
|||
```
|
||||
|
||||
You can preview the production build with `npm run preview`.
|
||||
|
||||
> To deploy your app, you may need to install an
|
||||
> [adapter](https://kit.svelte.dev/docs/adapters) for your target environment.
|
||||
|
|
Načítá se…
Odkázat v novém úkolu