Skip to content

nheek/bould

Repository files navigation

Bould

Bould front page

Bould boasts a very fast and intuitive blog platform that lets you easily browse through a catalog of blogs while having a visual appeal that's sure to attract readers.

Table of Contents

Getting Started

The installation is pretty straightforward, just follow the steps below and you should be good to go.

Prerequisites

  • Node.js
  • npm (usually comes with Node.js installation)

Installation

  1. Clone the repository:

    git clone https://github.com/nheek/bould.git your-project
  2. Change into the project directory:

    cd your-project
  3. Install dependencies:

    npm install

Development

Run the development server:

npm run dev

Usage

Bould can be used to showcase your blog articles and show your knowledge to your readers. It includes a simple markdown syntax integration with AstroJS that optimally does the conversion for you. It also lets you pre-design templates that you can use to visualise your blog articles in different ways depending on their categories, weight, or just your personal preference.

Deployment

  1. Build the project files
npm run build
  1. Run using the AstroJS command or use your production deployment method
npm start

Built With

Contributing

If you'd like to contribute, please fork the repository and create a pull request. Issues and feature requests are welcome!

License

This project is licensed under the GNU General Public License v3.0 - see the LICENSE file for details.

Acknowledgments

Special thanks to everyone who had indirect contributions to this project through the inclusion of their works which are specially mentioned in the source code.