Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
spudoodle authored Jun 19, 2024
1 parent 1acbe5e commit b12c03a
Showing 1 changed file with 31 additions and 23 deletions.
54 changes: 31 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -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).
<h1 align='center'>Read Realm</h1>
<p align='center'>Landing page for the website 'Read Realm', which sells and rents books online and hosts discussions.</p>

## Getting Started
## Demo

First, run the development server:
![image](https://github.com/Achal-00/readrealm/assets/106076516/1a5ecef2-925e-454e-a526-0c5d0f390973)

```bash
npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev
```
Check out the live website [here](https://achal-00.github.io/readrealm/).

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

You can start editing the page by modifying `app/page.js`. The page auto-updates as you edit the file.
- Next JS
- Tailwind CSS
- React JS
- Framer Motion
- GSAP

This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
## How to Run Locally

## Learn More
1. Clone this repository:
```bash
git clone https://github.com/Achal-00/readrealm.git

To learn more about Next.js, take a look at the following resources:
2. Navigate to the project directory:
```bash
cd readrealm
- [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.
3. Install dependencies:
```bash
npm install

You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
4. Start the development server:
```bash
npm run dev
## Deploy on Vercel
7. Open your browser and visit http://localhost:3000
## Contact Information
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.
For questions or feedbacks feel free to contact:
Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
- **Email:** achaldev3@gmail.com
- **LinkedIn:** [Achal](https://www.linkedin.com/in/achal-ab39652b4/)
- **Designed by:** [Sanand](https://www.behance.net/sanandchandran)

0 comments on commit b12c03a

Please sign in to comment.