Skip to content

devylab/bluga

Repository files navigation

Contributors Forks Stargazers Issues MIT License


Bluga

An open source blogging software
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Documentation
  4. Report a bug
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About Bluga

Bluga is an open source blogging software built on nodejs, that allows you to build and manage a blog with ease.

Why Bluga?:

  • It is easy to setup
  • It is lightweight
  • It is self-hosted (you can host it on your own cloud provider)
  • You can create your own custom theme on it

Built With

  • Nodejs
  • Fastify

Getting Started

To get the project running locally follow these simple steps below.

Prerequisites

To run Bluga on your local environment you will need to install the following

  • Node (node >= 18.9.0)

You can get a detailed instruction on how to install Node from their official documentation

  • Postgres

You can get a detailed instruction on how to install Postgres from their official documentation, or you can use the docker image here

Installation

  1. Clone the repo
    git clone https://github.com/devylab/bluga.git
  2. Install dependencies
    yarn install
  3. Duplicate the env.sample in the root directory, rename it to .env and update the content
  4. Start the project
    yarn dev

Documentation

For more examples, please refer to the Documentation

Report a bug

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

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

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

Contact

Cavdy - @DarklordCodes

Project Link: https://github.com/devylab/bluga

Acknowledgments