8000 Update README.md · codewithdev/codewithdev-vercel@5ab8ab4 · GitHub
[go: up one dir, main page]

Skip to content

Commit 5ab8ab4

Browse files
authored
Update README.md
1 parent 8467707 commit 5ab8ab4

File tree

1 file changed

+16
-5
lines changed

1 file changed

+16
-5
lines changed

README.md

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
1-
# codewithdev.github.io
1+
# Portfolio Blog V2
22

3+
Inspired from https://leerob.io/
4+
5+
### Building Blocks
6+
7+
To build a site similar to this, consider changing the LICENSE file first. The following frameworks/tools are used to build this site:
38
- **Framework**: [Next.js](https://nextjs.org/)
49
- **Database**: [PlanetScale](https://planetscale.com)
510
- **ORM**: [Prisma](https://prisma.io/)
@@ -8,7 +13,7 @@
813
- **CMS**: [Sanity](https://www.sanity.io/)
914
- **Styling**: [Tailwind CSS](https://tailwindcss.com/)
1015

11-
## Overview
16+
## File Structure Overview
1217

1318
- `layouts/*` - The different page layouts each MDX category (blog, snippets) uses.
1419
- `lib/*` - Short for "library", a collection of helpful utilities or code for external services.
@@ -22,17 +27,23 @@
2227
- `public/*` - Static assets including fonts and images.
2328
- `styles/*` - A small amount of global styles. I'm mostly using vanilla Tailwind CSS.
2429

25-
## Running Locally
30+
## Local setup
2631

2732
This application requires Node.js v16.13+.
2833

2934
```bash
30-
$ git clone https://github.com/leerob/leerob.io.git
31-
$ cd codewithdev.github.io
35+
$ git clone https://github.com/codewithdev/codewithdev-vercel.git
36+
$ cd codewithdev-vercel
3237
$ yarn
3338
$ yarn dev
3439
```
3540

41+
You will see the local build running on http://localhost:3000/
42+
43+
### Before you run local build
44+
- Create `.env` file and populate the API key and secrets used to successfully run the local build.
45+
46+
3647

3748
## Cloning / Forking
3849

0 commit comments

Comments
 (0)
0