BlogFlex ✨📝

Features 🚀

• User registration and authentication 🔐
• Session management with Gorilla Sessions 🍪
• JWT-based authentication middleware 🔑
• Post creation, listing, and detail views 📝
• Commenting system 💬
• Real-time updates with HTMX ⚡
• Responsive design with Bootstrap 📱
• TinyMCE advanced WYSIWYG HTML editor 🖋️
• Database management with Hasura using GraphQL with PostgreSQL 🗄️
• Containerization with Docker 🐳

Technologies Used

• Backend: Go, GraphQL, PostgreSQL, Hasura
• Frontend: HTMX, Templ, Bootstrap, TinyMCE WYSIWYG HTML editor
• Containerization: Docker

Getting Started

Prerequisites 📋

• Go (version 1.18 or later) 🐹
• HTMX
• Templ
• Docker 🐳
• Hasura Account
• Air for live reloading

Installation ⚙️

1. Clone the repository

   git clone https://github.com/yourusername/blogflex.git
   cd blogflex

2. Register a Hasura Account

Register for an account at Hasura.

3. Install Go dependencies

   go mod tidy

4. Set Up Environment Variables

Create a .env file in the root directory and add the necessary environment variables. For example: HASURA_ENDPOINT= HASURA_ADMIN_SECRET=

Directory Structure

blogflex/
├── .vscode/
│   └── launch.json
├── internal/
│   ├── auth/
│   │   └── auth.go
│   ├── database/
│   │   └── database.go
│   ├── handlers/
│   │   ├── blog_handlers.go
│   │   ├── comment_handlers.go
│   │   ├── post_handlers.go
│   │   └── user_handlers.go
│   ├── helpers/
│   │   ├── format_time.go
│   │   ├── graphql.go
│   │   ├── logged_in.go
│   │   └── respond_error.go
│   │   └── truncate_words.go
│   └── middleware/
│   │   └── auth.go
│   └── models/
│       └── structs.go
├── router/
│   └── router.go
├── views/
│   ├── blog_list.templ
│   │   └── blog_list_templ.go
│   ├── blog_page.templ
│   │   └── blog_page_templ.go
│   ├── create.templ
│   │   └── create_templ.go
│   ├── detail.templ
│   │   └── detail_templ.go
│   ├── edit.templ
│   │   └── edit_templ.go
│   ├── index.templ
│   │   └── index_templ.go
│   ├── navbar_components.templ
│   │   └── navbar_components_templ.go
│   ├── navbar.templ
│   │   └── navbar_templ.go
│   └── post_list.templ
│       └── post_list_templ.go
├── .air.toml
├── .env
├── docker-compose.yml
├── go.mod
├── go.sum
├── main.go
└── README.md

Running the Project Locally ▶️

To run the project locally, you have 3 options:

1. Launch Debugger:

   • Open your project in Visual Studio Code.
   • Set breakpoints as needed.
   • Launch the debugger by pressing F5 or by selecting Run > Start Debugging from the menu.

2. Run Air:

   • Ensure you have Air installed for live reloading.

   • Start Air by running the following command in your terminal:

     air

3. Run go run main.go Command:

   • Open your terminal.

   • Navigate to the project directory.

   • Run the following command to start the application:

     go run main.go

Note: Before running your project, make sure to generate the Templ files in the terminal to get the most updated UI. You can do this by running:

templ generate

Testing the API 🧪

To test the API endpoints, use the GraphQL queries in Hasura. Follow these steps:

1. Access Hasura Console:

   • Log in to your Hasura account at Hasura.
   • Navigate to your project's Hasura Console.

2. Navigate to the API Tab:

   • In the Hasura Console, go to the "API" tab.

3. Run GraphQL Queries:

   • Use the GraphQL query editor to write and execute your queries.
   • You can test various API endpoints by constructing appropriate GraphQL queries and mutations.

4. Inspect Responses:

   • Check the responses returned by the server to ensure your API is functioning correctly.

For more advanced testing, you can also use tools like Postman or Insomnia to send GraphQL requests to your Hasura endpoints.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgements

• Gorilla Mux
• HTMX
• Bootstrap
• TinyMCE
• Hasura
• Docker

---

Contributing 🤝

We welcome contributions! Please follow these steps to contribute:

1. Fork the repository.
2. Create a new branch (git checkout -b feature/your-feature-name).
3. Make your changes.
4. Commit your changes (git commit -m 'Add some feature').
5. Push to the branch (git push origin feature/your-feature-name).
6. Open a pull request.

Enjoy using BlogFlex! If you encounter any issues, please feel free to open an issue or submit a pull request.