From 2a71ade56f9efb359410ced53c6dee1f3e17983c Mon Sep 17 00:00:00 2001 From: Carsten Kragelund Date: Fri, 28 Jul 2023 14:07:55 +0200 Subject: [PATCH] docs: update README --- README.md | 38 -------------------------------------- README.org | 32 ++++++++++++++++++++++++++++++++ 2 files changed, 32 insertions(+), 38 deletions(-) delete mode 100644 README.md create mode 100644 README.org diff --git a/README.md b/README.md deleted file mode 100644 index 965a122..0000000 --- a/README.md +++ /dev/null @@ -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. diff --git a/README.org b/README.org new file mode 100644 index 0000000..bc86237 --- /dev/null +++ b/README.org @@ -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. \ No newline at end of file