Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #1

Closed
wants to merge 1 commit into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
52 changes: 30 additions & 22 deletions README.md
@@ -1,36 +1,44 @@
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).
### Prerequisites

## Getting Started
**Node version 18.x.x**

First, run the development server:
### Cloning the repository

```bash
npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev
```shell
git clone https://github.com/webprodigies/fuzzie-production.git
```

Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
### Install packages

```shell
npm i
```

You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
### Setup .env file

This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
[.env.example](https://github.com/webprodigies/fuzzie-production/blob/main/.env.example)

## Learn More
### Setup Prisma

To learn more about Next.js, take a look at the following resources:
Add PostgreSQL Database

- [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.
```shell
npx prisma generate
npx prisma db push

You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
```

## Deploy on Vercel
### Start the app

```shell
npm run dev
```

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.
## Available commands

Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
| command | description |
| :-------------- | :-----------------------------------------|
| `dev` | Starts a development instance of the app |
| `build` | Builds a production instance |
| `start` | Starts a production instance of the app |
| `lint` | Lints the app |