Skip to content

Commit 3ab136e

Browse files
Merge pull request #17 from LTU-D0020E/wilhelmrauston-patch-1
Update README.md
2 parents b5e176d + b90a052 commit 3ab136e

File tree

1 file changed

+17
-8
lines changed

1 file changed

+17
-8
lines changed

README.md

+17-8
Original file line numberDiff line numberDiff line change
@@ -2,23 +2,27 @@ This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next
22

33
## Getting Started
44

5+
Downloading dependencies:
6+
7+
```bash
8+
npm i
9+
# or
10+
npm install
11+
```
12+
13+
Adding necessary files:
14+
add a file called env.local inside src/ and add correct environment variables.
15+
516
First, run the development server:
617

718
```bash
819
npm run dev
9-
# or
10-
yarn dev
11-
# or
12-
pnpm dev
13-
# or
14-
bun dev
1520
```
1621

1722
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
1823

19-
You can start editing the page by modifying `pages/index.js`. The page auto-updates as you edit the file.
2024

21-
[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.js`.
25+
[API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://localhost:3000/api/v1/something](http://localhost:3000/api/v1/something). As mentioned before pages/api will take the relative url to perform API calls
2226

2327
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.
2428

@@ -38,3 +42,8 @@ You can check out [the Next.js GitHub repository](https://github.com/vercel/next
3842
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.
3943

4044
Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
45+
46+
47+
##Additional Information
48+
49+
This project has been using MongoDB for data storage. You will have to create a new MongoDB database and add the URI to the env.local (DO NOT STORE THOSE STRINGS IN env.example).

0 commit comments

Comments
 (0)