Codegarden 🌱

My personal internet existence. A codegarden is a digital space for a developer to grow and nourish themselves into the best programmer they can be.

What's it built with?

Wanna know what I used to build it without diving too far into the source code? Yeah?! Well, here you go.

• Framework (Next13 /app dir): Next.js
• Deployment: Vercel
• CMS/Content: contentlayer
• Styles: tailwindcss
• Database: Planetscale

Not to mention my blood, sweat, and tears. Maybe some banging my head on the table as well.

What's still to come?

• move all api routes to a /api folder
• redesign /reading
• create /snippets
• create /bookmarks
• add error boundaries
• custom 404 page
• custom 500 page

Running Locally

There a few minor steps to getting up and running.

1. Clone the Repo

git clone https://github.com/emma-campbell/codegarden

2. Install Dependencies

yarn # npm i

3. Configure the Env

If you want to mess around with database features (metrics like views and likes) then you'll need to set up a PlanetScale database.

Luckily, I have a quick blurb about setting up the database and necessary links here. Keep your database url in a safe place. You'll want to duplicate the .env.example file and replace anything in angled brackets <replace_me> with the needed value.

4. Start the Server

yarn dev

Repository Structure

The repository is structure as follows

.
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── LICENSE.md
├── README.md
├── content
├── contentlayer.config.js
├── lib
├── next-env.d.ts
├── next.config.js
├── node_modules
├── package.json
├── pages
├── postcss.config.js
├── prisma
├── public
├── styles
├── tailwind.config.js
├── tsconfig.json
├── ui
└── yarn.lock

• content - articles/posts and related definitions
• lib - resuable library code (like hooks)
• pages - next pages
• primsa - database ORM definitions
• public - hosted assets
• styles - css and styling files
• ui - reusable components

Contributing

If you see an open issue and want to tackle it, please be my guest! I am happy to help you boast the number of repo's your contributing to (while, admittably there are other more import open-source projects to constribute to).

My contribution guidelines are a working in progress, but any current standards are documented on my contributions page

License

Please reference my license for relevant information.