docs: update README
parent
31fae7424a
commit
2a71ade56f
@ -1,38 +0,0 @@
|
||||
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).
|
||||
|
||||
## Getting Started
|
||||
|
||||
First, run the development server:
|
||||
|
||||
```bash
|
||||
npm run dev
|
||||
# or
|
||||
yarn dev
|
||||
# or
|
||||
pnpm dev
|
||||
```
|
||||
|
||||
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
|
||||
|
||||
You can start editing the page by modifying `pages/index.tsx`. 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.ts`.
|
||||
|
||||
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.
|
||||
|
||||
This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
|
||||
|
||||
## 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.
|
@ -0,0 +1,32 @@
|
||||
* Rapid Test
|
||||
|
||||
This is a [[Rapid][https://rapid.cincinnati.ventures/]] project bootstrapped with =rapid new --nextjs=
|
||||
This uses NextJS for the frontend and Rapid to allow for typesafe Rust function for the API routes.
|
||||
|
||||
** Getting Started
|
||||
|
||||
First, run the rapid development server:
|
||||
|
||||
#+BEGIN_SRC bash
|
||||
rapid run
|
||||
#+END_SRC
|
||||
|
||||
Then run the NextJS development server
|
||||
|
||||
#+BEGIN_SRC bash
|
||||
npm run dev
|
||||
#+END_SRC
|
||||
|
||||
Open [[http://localhost:3000][http://localhost:3000]] with your browser to see the result.
|
||||
|
||||
You can start editing the page by modifying =app/page.tsx=. The page auto-updates as you edit the file.
|
||||
|
||||
You can find the Rust API routes in the =pages/api= directory.
|
||||
|
||||
** Learn More
|
||||
|
||||
To learn more, take a look at the following resources:
|
||||
|
||||
- [[Next.js Documentation][https://nextjs.org/docs]] - learn about Next.js.
|
||||
- [[React Documentation][https://react.dev/]] - learn about React.
|
||||
- [[Rapid Documentation][https://rapid.cincinnati.ventures/docs]] - learn about Rapid.
|
Loading…
Reference in New Issue