Adam's Blog

Welcome to my personal blog, a no-frills space dedicated to sharing my coding journey. Eschewing the complexities of CMS platforms, this blog centers on the reader. Dive in to explore my thoughts, lessons, and adventures in coding!

Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

• Design: Clean and intuitive. Simplicity is key.
• Content: Primarily posts, with a comment section in the pipeline.
• UX: Seamless reading experience across devices, ensuring accessibility.

(back to top)

Built With

Frontend

Backend

Tools

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

• npm

  npm install npm@latest -g

• PostgreSQL instance

Installation

1. Clone the repo

   git clone https://github.com/am1macdonald/myblog.git

2. Install NPM packages

   npm install

3. Set up environment variables

   touch .env.local

   DATABASE_URL="postgresql://user:password@host:port/database"

   see env.example files for more details

Usage

This is a personal project and is not intended for use by others. However, if you would like to use it as a template for your own blog, feel free to fork the repo and make it your own.

Roadmap

• 'All Posts' page
• Comment section for posts
• CMS system for Admin user (me!)

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Not taking contributions but anybody is welcome to fork the repo and make it their own.

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Adam MacDonald - LinkedIn

Project Link: https://github.com/am1macdonald/myblog

(back to top)