-
Notifications
You must be signed in to change notification settings - Fork 50
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(frontend): simple instructions (#1619)
* docs(frontend): simple instruction * docs(tavla): change directory
- Loading branch information
1 parent
0a183f7
commit 49e817c
Showing
1 changed file
with
25 additions
and
25 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,38 +1,38 @@ | ||
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 | ||
|
||
## Getting Started | ||
## Prerequisites | ||
|
||
First, run the development server: | ||
To run the project locally, you need to have the following installed: | ||
|
||
```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 `app/page.tsx`. The page auto-updates as you edit the file. | ||
- [Node.js](https://nodejs.org/) | ||
- [Yarn](https://yarnpkg.com/) | ||
|
||
[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`. | ||
## Installation | ||
|
||
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. | ||
Clone the repository and install the dependencies: | ||
|
||
This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font. | ||
```bash | ||
git clone https://github.com/entur/tavla.git | ||
cd tavla/tavla | ||
yarn install | ||
``` | ||
|
||
## Learn More | ||
## Running the application | ||
|
||
To learn more about Next.js, take a look at the following resources: | ||
To start the application in development mode, use: | ||
|
||
- [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. | ||
```bash | ||
yarn dev | ||
# or | ||
yarn dev:persist #persists the local database | ||
``` | ||
|
||
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome! | ||
This will start the development server at `http://localhost:3000` | ||
|
||
## Deploy on Vercel | ||
## Environment variables | ||
|
||
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. | ||
You need to set the backend api key, create a `.env.local` file at the root of `/tavla`. | ||
|
||
Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details. | ||
```sh | ||
BACKEND_API_KEY="secret_key" | ||
``` |