Skip to content

Commit 4bd1005

Browse files
committed
docs: add a proper readme
1 parent 37f02fd commit 4bd1005

File tree

1 file changed

+23
-43
lines changed

1 file changed

+23
-43
lines changed

README.md

Lines changed: 23 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,54 +1,34 @@
11
# Next.js Sentinel
22

3-
```sh
4-
npm create astro@latest -- --template basics
5-
```
3+
Monitor Next.js releases, analyze them with an LLM for relevance to Netlify,
64

7-
[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/basics)
8-
[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/basics)
9-
[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/withastro/astro?devcontainer_path=.devcontainer/basics/devcontainer.json)
5+
## Development
106

11-
> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
7+
This is an Astro site.
128

13-
![just-the-basics](https://github.com/withastro/astro/assets/2244813/a0a5533c-a856-4198-8470-2d67b1d7c554)
9+
It stores Next.js release data in a Turso database.
1410

15-
## 🚀 Project Structure
11+
It is deployed to Netlify.
1612

17-
Inside of your Astro project, you'll see the following folders and files:
13+
It uses the PNPM package manager.
1814

19-
```text
20-
/
21-
├── public/
22-
│ └── favicon.svg
23-
├── src/
24-
│ ├── components/
25-
│ │ └── Card.astro
26-
│ ├── layouts/
27-
│ │ └── Layout.astro
28-
│ └── pages/
29-
│ └── index.astro
30-
└── package.json
31-
```
32-
33-
Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name.
34-
35-
There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.
36-
37-
Any static assets, like images, can be placed in the `public/` directory.
38-
39-
## 🧞 Commands
15+
### 🧞 Commands
4016

4117
All commands are run from the root of the project, from a terminal:
4218

43-
| Command | Action |
44-
| :------------------------ | :----------------------------------------------- |
45-
| `npm install` | Installs dependencies |
46-
| `npm run dev` | Starts local dev server at `localhost:4321` |
47-
| `npm run build` | Build your production site to `./dist/` |
48-
| `npm run preview` | Preview your build locally, before deploying |
49-
| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
50-
| `npm run astro -- --help` | Get help using the Astro CLI |
51-
52-
## 👀 Want to learn more?
53-
54-
Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat).
19+
| Command | Action |
20+
| :------------------- | :--------------------------------------------------------- |
21+
| `pnpm install` | Install dependencies |
22+
| `pnpm run dev` | Start local dev server at `localhost:4321` |
23+
| `pnpm run build` | Build your production site to `./dist/` |
24+
| `pnpm run format` | Format files with prettier |
25+
| `pnpm run lint` | Run ESLint |
26+
| `pnpm run typecheck` | Typecheck TypeScript files |
27+
| `pnpm run test` | Run all checks, including typechecking & eslint |
28+
| `pnpm run preview` | Preview your build locally, before deploying |
29+
| `pnpm run migrate` | Fetch recent releases, analyze them, and seed the database |
30+
31+
### Contributing
32+
33+
The release data is in a plain JSON file in `src/data/releases.json`. Feel free
34+
to send PRs with updates.

0 commit comments

Comments
 (0)