GoStart/readme.md

47 lines
1.7 KiB
Markdown
Raw Normal View History

2024-05-15 20:28:12 +00:00
# GoStart
This is a basic starter project for building web applications using Go, Tailwind CSS, and htmx. It provides a foundation for creating interactive and responsive web applications without relying on any third-party dependencies, utilizing only the packages included with the Go language by default.
## Features
- **Go**: The project is built using Go, a powerful and efficient programming language for building scalable and high-performance applications.
- **Tailwind CSS**: Tailwind CSS is used for styling the web application, providing a utility-first CSS framework that enables rapid UI development.
- **htmx**: htmx is a lightweight library that allows you to add interactive features to your web pages without writing JavaScript, enabling server-side rendering and reducing the need for complex client-side code.
- **Bring Your Own Database**: This starter project does not include a specific database implementation, allowing you to choose and integrate the database solution that best fits your project's requirements.
### Getting Started
1. Clone the repository:
```bash
2024-05-29 01:16:41 +00:00
git clone https://forge.happytavern.co/oceanslim/gostart.git
2024-05-15 20:28:12 +00:00
```
2. Navigate to the project directory:
```bash
cd GoStart
```
3. Setup your configuration
```bash
cp config.example.json config.json
```
4. Build and run the application:
```bash
go run main.go
```
The application will be accessible at `http://localhost:8787`, or whatever port you set in your configuration.
### Contributing
Contributions to this project are welcome! If you find any issues or have suggestions for improvements, please open an issue or submit a pull request.
### License
This project is licensed under the [MIT License](LICENSE).