Update README

This commit is contained in:
2022-06-07 02:27:04 +03:00
parent 170a23b1b0
commit 0280ab14af

View File

@@ -1,34 +1,17 @@
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).
# Runosaari web application re-write
## Getting Started
This project serves the same purpose as [runosaari.net](https://github.com/codevictory/runosaari.net) but is more suitable for current needs of organizers.
First, run the development server:
## Reasoning
```bash
npm run dev
# or
yarn dev
```
### Priorities then:
- content editability
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
### Priorities now:
- styling
- custom design
- performance
You can start editing the page by modifying `pages/index.tsx`. The page auto-updates as you edit the file.
## Solution
[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.
## 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.
Re-write with NextJS, React and Vercel.