Skip to content

Commit

Permalink
doc(readme): update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Ikram-Maulana committed Jan 25, 2024
1 parent c3b0045 commit 77222f5
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 22 deletions.
61 changes: 39 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,53 @@
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).
# Simple Portfolio

## Getting Started
This is a simple portfolio website that I made using Next.js and Tailwind CSS. It is a responsive website that can be viewed on any device.

First, run the development server:
- Live example hosted on Vercel: [https://ikrammaulana.my.id](https://ikrammaulana.my.id)

```bash
npm run dev
# or
yarn dev
# or
pnpm dev
```
![Simple Portfolio](image.png)

Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
## 🖥️ Running Locally

You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
1. Clone this repository

[http://localhost:3000/api/hello](http://localhost:3000/api/hello) is an endpoint that uses [Route Handlers](https://beta.nextjs.org/docs/routing/route-handlers). This endpoint can be edited in `app/api/hello/route.ts`.
```bash
git clone https://github.com/Ikram-Maulana/neon-portfolio.git
```

This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
2. Create `.env` file in root directory

## Learn More
```bash
touch .env
```

To learn more about Next.js, take a look at the following resources:
3. Add your DATABASE_URL and CLOUDINARY_CLOUD_NAME to `.env` file

- [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
DATABASE_URL="your_database_url"
NEXT_PUBLIC_CLOUDINARY_CLOUD_NAME="your_cloudinary_cloud_name"
```

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

## Deploy on Vercel
```bash
cd neon-portfolio
npm install
```

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.
5. Start the development server

Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
```bash
npm run dev
```

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

## 🚀 Deploy on Vercel

1. Fork this repository

2. Create new project on [Vercel](https://vercel.com/)

3. Connect your repository to Vercel

4. Deploy your project
Binary file added image.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 77222f5

Please sign in to comment.