Skip to content

Commit

Permalink
Merge pull request #17 from LTU-D0020E/wilhelmrauston-patch-1
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
wilhelmrauston authored Mar 21, 2024
2 parents b5e176d + b90a052 commit 3ab136e
Showing 1 changed file with 17 additions and 8 deletions.
25 changes: 17 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,27 @@ This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next

## Getting Started

Downloading dependencies:

```bash
npm i
# or
npm install
```

Adding necessary files:
add a file called env.local inside src/ and add correct environment variables.

First, run the development server:

```bash
npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun 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.js`. 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.js`.
[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

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.

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


##Additional Information

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 comments on commit 3ab136e

Please sign in to comment.